Guardrails / docs

Repository has a README

docs/readme@v1

The repository has a README that says more than just its title.

Id	docs/readme
Version	v1
Category	docs
Default severity	warning
Interpreter	python3
Timeout	30 seconds
Violations tolerated	0
Collects	files

Collectors

This guardrail doesn't gather anything itself. It relies on the collectors below, which the CLI runs once per build before any check, and reads what they found from GUARDRAIL_FACTS. If a collector collects nothing, this guardrail is skipped, not failed.

Collector	Gathers	Inputs it is given
files	Presence, size and line counts of the well known files a repository is expected to carry, plus any extra path the guardrail asks for.	path

The inputs above are this guardrail's own inputs, passed straight through to the collector. Setting one in buildnote.json changes what is collected, and two guardrails configured the same way share a single collection.

Configuration

{
  "guardrails": {
      "failOn": "error",
      "checks": [
          {
              "use": "docs/readme@v1",
              "severity": "warning",
              "with": {
                  "path": "README.md",
                  "minLines": "10"
              },
              "exemptions": []
          }
      ]
  }
}

Inputs

Input	Description	Default	Environment variable
path	Path to the README, relative to the directory the CLI runs in.	README.md	GUARDRAIL_INPUT_PATH
minLines	How many non-blank lines the README needs before it counts as written.	10	GUARDRAIL_INPUT_MINLINES

How to fix

Add a README.md at the repository root explaining what the project is, how to build it and how to run it. A stub that only repeats the repository name is worse than no README, because it looks like the question has been answered.

More in docs

• docs/agent-instructions. The repository has an instruction file for coding agents, long enough to say something and short enough to be read in full.
• docs/changelog. The repository has a changelog, so what changed between two releases is written down instead of pieced together from commits.
• docs/code-of-conduct. The repository has a CODE_OF_CONDUCT.md, so the standard contributors are held to, and who enforces it, is written down.
• docs/contributing. The repository has a CONTRIBUTING.md explaining how a change is proposed, built and reviewed.
• docs/license-present. The repository has a licence file, so what people may do with the code is written down, not assumed.
• docs/security-policy. The repository has a SECURITY.md saying where to report a security problem.

All 7 docs guardrails