docs: Document local development gates and toolchain in CONTRIBUTING
This commit is contained in:
1 file changed
+22
@@ -13,6 +13,28 @@ cargo test
|
||||
cargo build --release
|
||||
```
|
||||
|
||||
## Local development gates
|
||||
|
||||
This repo enforces formatting, linting, documentation, license headers, and
|
||||
supply-chain policy. To run the same checks locally:
|
||||
|
||||
- One-time setup (installs the git hooks): `just setup`
|
||||
(or `git config core.hooksPath .githooks`)
|
||||
- Fast gate (runs automatically on commit): `just check`
|
||||
— `cargo fmt --check`, `cargo clippy --all-targets --all-features -- -D warnings`, `./scripts/check-headers.sh`
|
||||
- Full gate (run before pushing): `just test`, `just deny`, `just doc`
|
||||
|
||||
Tooling required: `rustfmt` + `clippy` (rustup components), and for the full gate
|
||||
`cargo install cargo-deny`. `just` is optional — the hook and CI call `cargo` directly.
|
||||
|
||||
Every `.rs` file must begin with:
|
||||
|
||||
// SPDX-License-Identifier: MIT
|
||||
// Copyright (c) 2026 James Maes
|
||||
|
||||
All public and private items must carry doc comments — `missing_docs` and
|
||||
`clippy::missing_docs_in_private_items` are denied (they fail the build, not just CI).
|
||||
|
||||
## Branches
|
||||
|
||||
Use `feature/*` branches for pull requests into `develop`.
|
||||
|
||||
Reference in new issue
Block a user