Goal
Make python -m dev_kit report --path <repo> --output devkit-report.md write a clean Markdown report that can be pasted into GitHub issues, release notes, or project notes.
Proposed report sections
- Project path and timestamp.
- Overall status summary.
- Version-label check results.
- Baseline file check results.
- Warnings and recommended next actions.
Guardrails
- Report generation must not mutate the audited project.
- Output path should be explicit and predictable.
- The report should be readable on mobile, not just in a terminal.
Acceptance checks
--output creates or overwrites only the requested report file.
- Report includes pass/fail summaries for each audit group.
- Missing output directory gives a friendly error.
- Unit tests cover report formatting and output behavior.
Goal
Make
python -m dev_kit report --path <repo> --output devkit-report.mdwrite a clean Markdown report that can be pasted into GitHub issues, release notes, or project notes.Proposed report sections
Guardrails
Acceptance checks
--outputcreates or overwrites only the requested report file.