GIT-012 critical documentation
README.md present
Repository has a README with accurate setup instructions
Question to ask
"Is the README still accurate, or is it lying to new devs?"
Verification guide
Severity: Critical
Check automatically:
ls -la README.md README readme.md 2>/dev/null
Verify contents - README should include:
- Project description (what is this?)
- Setup/installation instructions
- How to run locally
- How to run tests
Cross-reference with GIT-001 results:
- Do the README instructions match what actually worked when we cloned and ran?
- Flag any missing steps we had to figure out
- Flag any outdated instructions that didn't work
- Note any undocumented dependencies or env vars we discovered
Pass criteria:
- README exists with meaningful content
- Includes setup instructions
- Instructions match reality (verified in GIT-001)
Fail criteria:
- No README
- README is empty or just a title
- No setup instructions
- Instructions are outdated or incomplete vs actual setup
Evidence to capture:
- README exists (yes/no)
- Sections present (description, setup, run, test)
- Discrepancies between README and actual setup experience
- Suggested additions based on GIT-001 findings