slop/report-documents
No generated report documents are tracked
| Severity | warning |
| Tiers | all |
| Stacks | any |
| Scope | root |
| Kind | expr |
| Source | library v0.5.0 |
| Selected by | fleetlint-recommended@v0.5.0 |
Requirement
No status or summary documents such as FIX_SUMMARY.md, IMPLEMENTATION_REPORT.md or NEXT_STEPS.md are tracked at the root or in docs/. SUMMARY, REPORT, IMPLEMENTATION, ANALYSIS and UPDATES count only with a prefix or suffix, so mdBook’s and GitBook’s SUMMARY.md and a design document named IMPLEMENTATION.md are not findings.
Why
They describe one working session, go stale with the next commit and bury the documentation that is maintained.
Check
For each item in:
tracked().filter(p,
p.matches(r'^(docs/)?([A-Z0-9]+[_-])*(FIXES|PROGRESS|CHANGES_MADE|NEXT_STEPS|REFACTOR(ING)?_PLAN)([_-][A-Z0-9]+)*\.md$')
|| p.matches(r'^(docs/)?(([A-Z0-9]+[_-])+(SUMMARY|REPORT|IMPLEMENTATION|ANALYSIS|UPDATES)([_-][A-Z0-9]+)*|(SUMMARY|REPORT|IMPLEMENTATION|ANALYSIS|UPDATES)([_-][A-Z0-9]+)+)\.md$'))falseFix
Delete the file; move anything lasting into the README, an ADR or the changelog.
Agent instruction: Move lasting content into README, docs/adr or CHANGELOG and delete the file.
Sources
Generated by fleetlint docs from catalog v0.5.0.