Merge pull request #49 from epage/template

chore: Update from _rust template

.github/renovate.json5

@@ -32,7 +32,7 @@
       matchManagers: [
         'custom.regex',
       ],
-      matchPackageNames: [
+      matchDepNames: [
         'STABLE',
       ],
       extractVersion: '^(?<version>\\d+\\.\\d+)',  // Drop the patch version

.github/workflows/ci.yml

@@ -144,7 +144,7 @@ jobs:
       run: cargo install sarif-fmt --locked
     - name: Check
       run: >
-        cargo clippy --workspace --all-features --all-targets --message-format=json -- -D warnings --allow deprecated
+        cargo clippy --workspace --all-features --all-targets --message-format=json
         | clippy-sarif
         | tee clippy-results.sarif
         | sarif-fmt

.github/workflows/pre-commit.yml

@@ -24,4 +24,6 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - uses: actions/setup-python@v5
+      with:
+        python-version: '3.x'
     - uses: pre-commit/[email protected]

CONTRIBUTING.md

@@ -7,18 +7,18 @@ appreciate any level you're willing to do.
 
 Need some new functionality to help?  You can let us know by opening an
 [issue][new issue]. It's helpful to look through [all issues][all issues] in
-case its already being talked about.
+case it's already being talked about.
 
 ## Bug Reports
 
 Please let us know about what problems you run into, whether in behavior or
 ergonomics of API.  You can do this by opening an [issue][new issue]. It's
-helpful to look through [all issues][all issues] in case its already being
+helpful to look through [all issues][all issues] in case it's already being
 talked about.
 
 ## Pull Requests
 
-Looking for an idea? Check our [issues][issues]. If it's look more open ended,
+Looking for an idea? Check our [issues][issues]. If the issue looks open ended,
 it is probably best to post on the issue how you are thinking of resolving the
 issue so you can get feedback early in the process. We want you to be
 successful and it can be discouraging to find out a lot of re-work is needed.
@@ -41,15 +41,18 @@ As a heads up, we'll be running your PR through the following gauntlet:
 Not everything can be checked automatically though.
 
 We request that the commit history gets cleaned up.
+
 We ask that commits are atomic, meaning they are complete and have a single responsibility.
-PRs should tell a cohesive story, with test and refactor commits that keep the
+A complete commit should build, pass tests, update documentation and tests, and not have dead code.
+
+PRs should tell a cohesive story, with refactor and test commits that keep the
 fix or feature commits simple and clear.
 
-Specifically, we would encouage
+Specifically, we would encourage
 - File renames be isolated into their own commit
-- Add tests in a commit before their feature or fix, showing the current behavior.
+- Add tests in a commit before their feature or fix, showing the current behavior (i.e. they should pass).
   The diff for the feature/fix commit will then show how the behavior changed,
-  making it clearer to reviewrs and the community and showing people that the
+  making the commit's intent clearer to reviewers and the community, and showing people that the
   test is verifying the expected state.
   - e.g. [clap#5520](https://github.com/clap-rs/clap/pull/5520)
 

Cargo.toml

@@ -70,6 +70,7 @@ rc_mutex = "warn"
 redundant_feature_names = "warn"
 ref_option_ref = "warn"
 rest_pat_in_fully_bound_structs = "warn"
+result_large_err = "allow"
 same_functions_in_if_condition = "warn"
 self_named_module_files = "warn"
 semicolon_if_nothing_returned = "warn"
@@ -100,8 +101,7 @@ include.workspace = true
 
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples"]
+rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]
 
 [package.metadata.release]
 pre-release-replacements = [

README.md

@@ -19,7 +19,7 @@ at your option.
 
 Unless you explicitly state otherwise, any contribution intentionally
 submitted for inclusion in the work by you, as defined in the Apache-2.0
-license, shall be dual licensed as above, without any additional terms or
+license, shall be dual-licensed as above, without any additional terms or
 conditions.
 
 [Crates.io]: https://crates.io/crates/dir-diff

deny.toml

@@ -87,6 +87,7 @@ allow = [
     "MIT",
     "MIT-0",
     "Apache-2.0",
+    "BSD-2-Clause",
     "BSD-3-Clause",
     "MPL-2.0",
     "Unicode-DFS-2016",

src/lib.rs

@@ -15,6 +15,10 @@
 #![warn(clippy::print_stderr)]
 #![warn(clippy::print_stdout)]
 
+#[doc = include_str!("../README.md")]
+#[cfg(doctest)]
+pub struct ReadmeDoctests;
+
 use std::cmp::Ordering;
 use std::path::Path;