Skip to content
oss-kit
GitHubInstall

The README opens with one sentence saying what the project does

Rule
R-DOC-01
Forge scope
GitHub and GitLab
Fixed by
oss-readme

A reader decides in about five seconds whether to keep reading. A title followed by a badge wall or a table of contents spends that budget on nothing.

Observable check

the first paragraph of README.md after the title is a single sentence naming what the project is and who it is for, and it appears before any table of contents, badge row, or ## heading.

Read the whole standard