Readme Required Sections
readme.readme-required-sections
Ensures the README contains required section headings (e.g., Installation, Usage). Configurable via the required_sections input parameter.
Compatible Integrations
This guardrail works with the following integrations. Click to see how to use Readme Required Sections with each collector.
Enable This Guardrail
Add the parent policy to your lunar-config.yml to enable this guardrail.
policies:
- uses: github://earthly/lunar-lib/policies/readme@v1.0.0
include: [readme-required-sections]
# with: ...How This Guardrail Works
This guardrail is part of the README Guardrails policy. It evaluates data collected by integrations and produces a pass/fail check with actionable feedback.
When enabled, this check runs automatically on every PR and in AI coding workflows, providing real-time enforcement of your engineering standards.
Learn How Lunar Works →Configuration Options
These inputs can be configured in your lunar-config.yml to customize
how the parent policy (and this guardrail) behaves.
| Input | Required | Default | Description |
|---|---|---|---|
min_lines
|
Optional |
25
|
Minimum number of lines required in README file |
required_sections
|
Required | — | Comma-separated list of required sections in README file |
README Guardrails
This guardrail is part of the README Guardrails policy, which includes 3 guardrails for repository and ownership.
Ready to Automate Your Standards?
See how Lunar can turn your engineering wiki, compliance docs, or postmortem action items into automated guardrails with our 100+ built-in guardrails.
Infrastructure conventions
Post-mortem action items
Security & compliance policies
Testing & quality requirements