Readme Exists

✓ Guardrail README Guardrails Stable Repository And Ownership

readme.readme-exists

Verifies that a README.md or README file exists in the repository root. Every repository should have basic documentation for discoverability.

readme documentation repository docs

Get Started View All README Guardrails

Compatible Integrations

This guardrail works with the following integrations. Click to see how to use Readme Exists with each collector.

Readme Exists + README Collector Provides README file metadata

→

Enable This Guardrail

Add the parent policy to your lunar-config.yml to enable this guardrail.

📄 lunar-config.yml

policies:
  - uses: github://earthly/lunar-lib/policies/readme@v1.0.0
    include: [readme-exists]
    # 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 →

↓ Integrations Gather Data

Collectors extract metadata from code, CI pipelines, tool outputs, and scans

{ } Centralized as JSON

All data merged into each component's unified metadata document

✓ This Guardrail Checks Current

Readme Exists runs and provides pass/fail feedback

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.

View Policy

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.

Works with any process

Infrastructure conventions

Post-mortem action items

Security & compliance policies

Testing & quality requirements

Book a Demo

See it work with your own use cases

See How It Works