fleetlint Policy for a fleet of repositories
v0.4
Getting started

repo/readme-present

README exists and has a quickstart

Severitywarning
Tiersall
Stacksany
Scoperoot
Kindexpr
Sourcelibrary v0.1.0
Selected byfleetlint-recommended@v0.1.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.

See: https://fleetlint.org/baseline/#documentation


Generated by fleetlint docs from catalog v0.1.0.