docs
7 guardrails, all at version v1.
| Guardrail | Default severity | What it checks |
|---|---|---|
docs/agent-instructions | info | The repository has an instruction file for coding agents, long enough to say something and short enough to be read in full. |
docs/changelog | info | The repository has a changelog, so what changed between two releases is written down instead of pieced together from commits. |
docs/code-of-conduct | info | The repository has a CODE_OF_CONDUCT.md, so the standard contributors are held to, and who enforces it, is written down. |
docs/contributing | info | The repository has a CONTRIBUTING.md explaining how a change is proposed, built and reviewed. |
docs/license-present | warning | The repository has a licence file, so what people may do with the code is written down, not assumed. |
docs/readme | warning | The repository has a README that says more than just its title. |
docs/security-policy | warning | The repository has a SECURITY.md saying where to report a security problem. |
You configure every guardrail in this category the same way, in the guardrails.checks array of buildnote.json. Configuring guardrails lists every option, and Guardrails lets you search the whole library.