From 6eafb7bfe800e0a96d52674a46903e06238536d0 Mon Sep 17 00:00:00 2001 From: Alexandre Pasmantier Date: Sun, 10 Nov 2024 20:28:28 +0100 Subject: [PATCH] chore: udate documentation and dependencies --- .github/ISSUE_TEMPLATE/bug_report.md | 29 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++++++ Cargo.lock | 14 +++++------ Cargo.toml | 2 +- README.md | 2 ++ 5 files changed, 59 insertions(+), 8 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..ac28c66 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,29 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Description** +A description of what the bug is. + +**Example** +A [minimal reproducible code example](https://stackoverflow.com/help/minimal-reproducible-example) where the bug happens. + +**Expected behavior** +A description of what you expected to happen. + +**Actual behavior** +A description of what actually happens. + +**Environment** + - OS: [e.g. Windows] + - Rust version: [e.g. 1.50.0] + - Project version: [e.g. 0.1.0] + - [Any other dependency version if needed] + +**Additional context** +Any other context about the bug here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..a0a5a66 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +**Problem** +A description of what is the problem that can be fixed with the feature you propose. + +**Feature** +A description of the feature you propose. + +**Examples** +One or more code examples that shows the feature in action. + +**Additional context** +Any other context about the feature request here. diff --git a/Cargo.lock b/Cargo.lock index 1cf5118..5f9eddc 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2740,9 +2740,9 @@ dependencies = [ [[package]] name = "rustix" -version = "0.38.39" +version = "0.38.40" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "375116bee2be9ed569afe2154ea6a99dfdffd257f533f187498c2a8f5feaf4ee" +checksum = "99e4ea3e1cdc4b559b8e5650f9c8e5998e3e5c1343b4eaf034565f32318d63c0" dependencies = [ "bitflags 2.6.0", "errno", @@ -3104,7 +3104,7 @@ dependencies = [ [[package]] name = "television" -version = "0.4.15" +version = "0.4.16" dependencies = [ "anyhow", "bat", @@ -3258,18 +3258,18 @@ checksum = "8f50febec83f5ee1df3015341d8bd429f2d1cc62bcba7ea2076759d315084683" [[package]] name = "thiserror" -version = "1.0.68" +version = "1.0.69" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "02dd99dc800bbb97186339685293e1cc5d9df1f8fae2d0aecd9ff1c77efea892" +checksum = "b6aaf5339b578ea85b50e080feb250a3e8ae8cfcdff9a461c9ec2904bc923f52" dependencies = [ "thiserror-impl", ] [[package]] name = "thiserror-impl" -version = "1.0.68" +version = "1.0.69" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a7c61ec9a6f64d2793d8a45faba21efbe3ced62a886d44c36a009b2b519b4c7e" +checksum = "4fee6c4efc90059e10f81e6d42c60a18f76588c3d74cb83a0b242a2b6c7504c1" dependencies = [ "proc-macro2", "quote", diff --git a/Cargo.toml b/Cargo.toml index a9de4a2..3d2db44 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "television" -version = "0.4.15" +version = "0.4.16" edition = "2021" description = "The revolution will be televised." license = "MIT" diff --git a/README.md b/README.md index 5c1a683..debfd80 100644 --- a/README.md +++ b/README.md @@ -146,6 +146,8 @@ is a simple TOML file that allows you to customize the behavior of `television` Any of these paths may be overriden by setting the `TELEVISION_CONFIG` environment variable to the path of your desired configuration folder. #### Default Configuration +The default configuration file can be found in [./.config/config.toml](./.config/config.toml). +
Television's default `config.toml`