diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b86b8a268..19c98dc63 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,6 +41,13 @@ This repository exists to be reviewable. Five rules keep it that way. template that emits the notice into a generated file) and is left alone; the three such files say so in a comment. +Before you ask for a merge, run `scripts/pre-pr-checks.sh`. It runs the six host-side checks described in +[docs/pre-pr-checks.md](docs/pre-pr-checks.md) and prints one line each (`--base ` for the registration check, `--list` +to see the commands); a check that cannot run says `skip` and why, and an unresolvable `--base` is a usage error rather than a +skip. None of them needs a device or a build, and each answers a question that a green CI tick and a careful read of your own +diff do not. The page also covers the one thing that is not a command: build the target that contains the file you edited, +which is not necessarily the target your test links. + ## RFCs: design before code Changes that shape the engine start as an RFC in