docs: improve CONTRIBUTING.md to more closely match CI execution #963
+23
−6
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated the pre-submission checklist to match CI requirements more closely: - Added --check flag to cargo fmt to verify formatting without modifying files - Added -D warnings flag to cargo clippy to treat warnings as errors - Added --all flag to cargo test to run tests across all workspace members - Added lockfile check command (cargo check --locked) - Included note about CI testing with multiple feature combinations 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
sholderbach
reviewed
Oct 21, 2025
CONTRIBUTING.md
Outdated
Comment on lines
55
to
58
| - the lockfile check | ||
|
|
||
| ```shell | ||
| cargo check --locked --all-targets --all |
There was a problem hiding this comment.
Not sure how many times that is actually relevant? Have you run into that failing?
There was a problem hiding this comment.
hi @sholderbach thanks for the feedback! I think i was a bit thrown off by the github actions CI calling this command, as parity with CI was the priority for this PR. It seems like clippy covers this behavior (checking that Cargo.lock matches Cargo.toml) and so i've edited the instructions with some consolidated commands and clarifying notes. While I believe this should cover things as far as matching CI, I wonder if some of the steps in the gh workflow can be consolidated?
Co-authored-by: Stefan Holderbach <[email protected]>
…ONTRIBUTING.md Rework the "To make the CI gods happy" section to mirror CI behavior: add explanatory preamble and section headers, update the Clippy command to use `--locked --all-targets --all-features`, switch tests to the `cargo nextest run --all --all-features` invocation, and add notes about the flags and nextest runner.
schlich
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request updates the development workflow instructions in
CONTRIBUTING.mdto ensure consistency with the project's CI checks and to help contributors catch issues earlier. The changes clarify and strengthen requirements for formatting, linting, testing, and lockfile validation.