Expand the contributing guide for external contributors#2097
Open
oliv3rdrt wants to merge 1 commit into
Open
Conversation
The external contributor section explained the fork and branch workflow but did not say how to actually build, test, or run the checks that CI enforces. Add short subsections covering environment setup and the Linux build dependencies, running the test suite, and running do_checks.sh before opening a pull request so contributors can reproduce the CI static checks locally.
oliv3rdrt
requested review from
ImplOfAnImpl,
anyxem and
erubboli
as code owners
July 21, 2026 14:59
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
While going through the repository as a new external contributor, I noticed the external contributor section of CONTRIBUTING.md explains forking and branching but does not cover how to actually build the project, run the tests, or run the checks that CI enforces. This adds a few short subsections to fill that gap:
cargo build, and the Linux build dependencies (build-essential, libdbus-1-dev, libusb-1.0-0-dev), plus a note that the checks script needs Python.cargo test --release --workspacecommand that CI uses, and a note that the heavier tests are ignored by default../do_checks.shto reproduce the CI static checks locally (fmt, clippy, cargo-deny, cargo-vet), including installing cargo-deny and cargo-vet.Everything is based on the existing CI workflows and do_checks.sh, so it should match what already runs. Addresses #673.