docs
7 guardrails, all at version v1.
| Guardrail | Default severity | What it checks |
|---|---|---|
docs/agent-instructions | info | The repository carries an agent instruction file, and it is long enough to say something and short enough to be read. |
docs/changelog | info | The repository carries a changelog, so what changed between two releases is written down rather than reconstructed from commits. |
docs/code-of-conduct | info | The repository carries a CODE_OF_CONDUCT.md, so the standard contributors are held to is written down and so is who enforces it. |
docs/contributing | info | The repository carries a CONTRIBUTING.md saying how a change is proposed, built and reviewed. |
docs/license-present | warning | The repository carries a licence file, so what may be done with the code is written down rather than assumed. |
docs/readme | warning | The repository has a README, and it says more than its title. |
docs/security-policy | warning | The repository carries a SECURITY.md naming where a security problem should be reported. |
Every guardrail in this category is configured the same way, in the guardrails.checks array of buildnote.json. See Configuring guardrails for every option, and Guardrails to search the whole library.