learning_ai_common_plat/.github/reports/coverage/README.md
2026-03-21 12:40:12 -07:00

1.8 KiB

Workspace Coverage Report Template

Saved workspace coverage reports should follow this structure.

Filename

Use a dated filename such as:

  • workspace-coverage-2026-03-21.md
  • workspace-coverage-web-only-2026-03-21.md
  • workspace-coverage-high-risk-first-2026-03-21.md

Required Sections

  1. Executive summary
  2. Workspace scorecard
  3. Repo-by-repo breakdown
  4. Cross-repo hotspot analysis
  5. Drill-down tables
  6. Recommended actions
  7. Command log summary
  8. Risks and blockers

Required Tables

Workspace scorecard

Repo Stack Coverage status Approx coverage Test health Dirty Notes

Hotspot table

Repo File or module Area Signal Why it matters Suggested next step

Action table

Priority Repo Action Effort Expected impact Safe to automate

Severity Bands

  • critical: broken coverage flow, major blind spots in high-risk code, or failing test infrastructure
  • high: meaningful uncovered business logic or weak test health in important surfaces
  • medium: partial gaps with reasonable existing safety nets
  • low: minor or cosmetic gaps with limited risk

Coverage Bands

  • <50%
  • 50-69%
  • 70-84%
  • 85%+

Repo Drill-Down Checklist

For each repo, capture:

  • what was run
  • what coverage data was available
  • what failed and why
  • top weakly covered areas
  • the smallest sensible next action

Notes

  • Keep saved reports concise and decision-ready.
  • Prefer exact file or module names over vague subsystem labels.
  • Separate setup blockers from actual code-risk coverage gaps.