Skip to content

docs: improve CONTRIBUTING.md to more closely match CI execution #963

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: improve CONTRIBUTING.md to more closely match CI execution #963

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b4d4ee4
docs: improve CONTRIBUTING.md with stricter CI check commands
schlich Oct 14, 2025
8b769ff
Remove unnecessary check after `cargo fmt` instructions
schlich Oct 21, 2025
7e20b25
docs: clarify CI checks and update formatting/lint/test commands in C…
schlich Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,25 @@ Before submitting a PR make sure to run:
- for formatting

```shell
cargo fmt --all
cargo fmt --all -- --check
```

- the clippy lints
- the clippy lints (with warnings treated as errors)

```shell
cargo clippy
cargo clippy --all-targets --all -- -D warnings
```

- the test suite

```shell
cargo test
cargo test --all
```

- the lockfile check

```shell
cargo check --locked --all-targets --all
Copy link
Member

@sholderbach sholderbach Oct 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure how many times that is actually relevant? Have you run into that failing?

Copy link
Author

@schlich schlich Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

```

Note: CI runs these checks across multiple feature combinations (`bashisms`, `sqlite`, `external_printer`, etc.), so you may want to test with the features relevant to your changes using the `--features` flag.