repo/readme-present
README exists and has a quickstart
| Severity | warning |
| Tiers | all |
| Stacks | any |
| Scope | root |
| Kind | expr |
| Source | library v0.6.0 |
| Selected by | fleetlint-recommended@v0.6.0 |
Requirement
A README (README.md, README, README.rst, README.adoc, any case) of at least 10 lines has a heading on installing, running or using the project: install, quickstart, getting started, usage, setup, run, develop, build or how to.
Why
The first screen of the README must be enough to run the project.
Check
glob("*").exists(f, f.matches(r'^(?i)readme(\.(md|markdown|rst|adoc|asciidoc|txt|org))?$')
&& size(lines(f)) >= 10
&& (text(f).matches(r'(?im)^(#{1,3}|={1,3})\s+.*\b(install|quick ?start|getting started|usage|setup|run|running|develop|development|build|building|how to)')
|| text(f).matches(r'(?im)^[^\n]*\b(install|quick ?start|getting started|usage|setup|run|running|develop|development|build|building|how to)[^\n]*\n[=\-~^]{3,}\s*$')))Fix
Write a README with purpose, requirements, quickstart and the task-runner targets.
Agent instruction: Write README.md: 2-3 sentence purpose, requirements, quickstart commands, the make targets, configuration table. Plain language, no marketing.
A finding of this rule points at README.md.
Sources
- https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes (guidance)
- https://fleetlint.org/baseline/#documentation
Generated by fleetlint docs from catalog v0.6.0.