Why
A contributor who reads the Running section will run just check expecting a compile check and be surprised when it auto-formats and auto-fixes clippy lints — a side-effecting operation they may not have intended.
Current state
CONTRIBUTING.md line 54 reads:
just check # verify workspace compiles
The actual check recipe in justfile is:
check:
taplo fmt
taplo check
cargo fmt
cargo clippy --fix --allow-dirty --allow-staged {{_features}} -- -D warnings
It runs taplo fmt, taplo check, cargo fmt, and cargo clippy --fix — formatting and linting with autofixes, not a plain compile check. A plain compile check is cargo check or just build.
Ideal state
- The inline comment next to
just check in CONTRIBUTING.md accurately reflects what the recipe does: format + lint with autofixes.
Starting points
CONTRIBUTING.md line 54 — the comment to updatejustfile — the check recipe for the authoritative description
QA plan
- Read
CONTRIBUTING.md lines 51–57 — expect the comment next to just check to describe formatting and linting, not compiling.
- Run
just check in a clean working tree — confirm it runs taplo fmt, cargo fmt, and cargo clippy --fix as described.
Done when
The comment next to just check in CONTRIBUTING.md accurately describes the recipe (format + lint, not compile).
Why
A contributor who reads the Running section will run
just checkexpecting a compile check and be surprised when it auto-formats and auto-fixes clippy lints — a side-effecting operation they may not have intended.Current state
CONTRIBUTING.mdline 54 reads:just check # verify workspace compilesThe actual
checkrecipe injustfileis:It runs
taplo fmt,taplo check,cargo fmt, andcargo clippy --fix— formatting and linting with autofixes, not a plain compile check. A plain compile check iscargo checkorjust build.Ideal state
just checkinCONTRIBUTING.mdaccurately reflects what the recipe does: format + lint with autofixes.Starting points
CONTRIBUTING.mdline 54 — the comment to updatejustfile— thecheckrecipe for the authoritative descriptionQA plan
CONTRIBUTING.mdlines 51–57 — expect the comment next tojust checkto describe formatting and linting, not compiling.just checkin a clean working tree — confirm it runstaplo fmt,cargo fmt, andcargo clippy --fixas described.Done when
The comment next to
just checkinCONTRIBUTING.mdaccurately describes the recipe (format + lint, not compile).