Skip to content

docs: update report format to match implementation#32

Merged
packet-mover merged 1 commit intomainfrom
docs/update-report-format
Apr 16, 2026
Merged

docs: update report format to match implementation#32
packet-mover merged 1 commit intomainfrom
docs/update-report-format

Conversation

@packet-mover
Copy link
Copy Markdown
Contributor

Summary

  • Update the report format section in README.md to match what GenerateReport actually produces
  • Old: per-repo tables with ✅/❌ emoji, repos sorted alphabetically
  • New: header with compliant/skipped counts, collapsible <details> sections grouped by compliance status (fully compliant / non-compliant / skipped), non-compliant repos show only failing rules

The report format section described an older design (per-repo tables
with pass/fail emoji) that was never implemented. Update to match the
actual output: header with compliant/skipped counts, summary table
sorted by pass rate, collapsible details sections grouped by compliance
status, and skipped repos with reasons.
@packet-mover packet-mover merged commit 994fc12 into main Apr 16, 2026
2 checks passed
@packet-mover packet-mover deleted the docs/update-report-format branch April 16, 2026 20:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant