| title | Reports Directory | |||||
|---|---|---|---|---|---|---|
| description | Repository for all generated reports, analysis outputs, audit files, and agent execution summaries. Includes analysis, audits, implementation tracking, migration reports, and metrics. | |||||
| file_type | documentation | |||||
| version | v1.1 | |||||
| last_updated | 2026-05-31 | |||||
| created_date | 2026-05-01 | |||||
| authors |
|
|||||
| maintainer | LightSpeed Team | |||||
| license | GPL-3.0 | |||||
| tags |
|
|||||
| domain | governance | |||||
| stability | stable |
This directory contains all generated reports, analysis outputs, audit files, and agent execution summaries.
- Store all Copilot/agent-generated reports
- Centralize analysis and audit outputs
- Maintain organized report archives
- Provide single source of truth for all reporting artifacts
.github/reports/
├── analysis/ # Code analysis, technical audits, and investigation reports
├── audits/ # One-time audit outputs (compliance, schema validation, system audits)
├── implementation/ # Implementation tracking, completion summaries, and rollout reports
├── migration/ # Migration reports, data transfer logs, and transition documentation
├── validation/ # Schema validation, config validation, and compliance reports
├── agents/ # Agent execution reports, completion summaries, and performance logs
├── coverage/ # Test coverage reports and quality metrics
├── frontmatter/ # Frontmatter schema validation and compliance reports
├── issue-metrics/ # GitHub issue analytics, metrics, and trends
├── labeling/ # Label automation reports, sync logs, and refactoring analysis
├── linting/ # ESLint baselines, code quality reports, and wave plans
├── meta/ # Documentation metadata (badges, references, footer updates)
├── metrics/ # General metrics collection, weekly summaries, and trend reports
├── optimisation/ # Performance optimisation reports, token reduction, context analysis
└── progress/ # Daily updates and weekly summaries for long-running work
Purpose: General code and system analysis reports that don't fit into more specific categories.
Examples:
- Technical debt analysis
- Architecture reviews
- Dependency audits
- Security scans
Purpose: Formal audit reports for compliance, standards verification, and system-wide checks.
Examples:
frontmatter-compliance-audit-2025-12-09.csvworkflow-security-audit-2025-12-09.mdaccessibility-audit-report.md
Purpose: Track implementation progress, feature rollouts, and completion summaries.
Examples:
phase-5-implementation-summary-2025-12-09.mdfeature-rollout-status.mddeployment-completion-report.md
Purpose: Document file migrations, data transfers, and system transitions.
Examples:
file-organization-migration-2025-12-09.mddatabase-migration-log-2025-12-10.mdapi-version-transition-report.md
Purpose: Validation results for schemas, configurations, and standards compliance.
Examples:
schema-validation-errors-2025-12-09.jsonconfig-compliance-report.mdfrontmatter-validation-summary.md
Purpose: Reports generated by automated agents, including completion summaries and performance metrics.
Examples:
labeling-agent-completion-2025-12-09.mdrelease-agent-summary.mdautomation-performance-metrics.json
Purpose: Test coverage reports and quality assurance metrics.
Examples:
test-coverage-summary-2025-w50.mdunit-test-coverage-report.htmlintegration-coverage-metrics.json
Purpose: Frontmatter-specific validation, compliance checks, and schema reports.
Examples:
frontmatter-schema-errors-2025-12-09.jsonmissing-frontmatter-report.mdfrontmatter-compliance-summary.csv
Purpose: GitHub issue analytics, metrics collection, and trend analysis.
Examples:
weekly-issue-metrics-2025-w50.jsonissue-resolution-trends.mdlabel-distribution-analysis.csv
Purpose: Label automation reports, synchronization logs, and label refactoring analysis.
Examples:
label-sync-log-2025-12-09.mdlabeling-refactor-analysis.mdlabel-coverage-report-run-12345.json
Purpose: Code quality reports, ESLint baselines, and linting wave plans.
Examples:
eslint-baseline-2025-12-09.jsonlinting-wave-1-plan.mdcode-quality-improvements-summary.md
Purpose: Documentation metadata reports including badge updates, reference tracking, and footer management.
Examples:
badge-application-metrics-2025-12-09.jsonfooter-update-summary.mdreference-link-validation.csv
Purpose: General metrics collection, weekly summaries, and organizational health tracking.
Examples:
weekly-summary-2025-12-08.mdrepository-health-metrics.jsoncontributor-activity-trends.csv
Purpose: Performance optimisation analysis, token reduction reports, and efficiency improvements.
Examples:
priority1-analysis-2025-12-09.txttoken-reduction-summary.mdcontext-optimisation-report.json
Purpose: Chronological updates for multi-day or multi-week projects, including daily updates and weekly summaries.
Examples:
daily-update-2025-12-11.mdweekly-summary-2025-w50.mdweek-of-2025-12-15-platform-refresh.md
Use descriptive names with timestamps for time-specific reports:
{type}-{subject}-{timestamp}.{ext}
Examples:
optimisation/priority1-analysis-2025-12-09.txt
audits/frontmatter-compliance-2025-12-09.csv
labeling/summary-run-12345.md
metrics/weekly-summary-2025-w50.json
migration/file-organization-migration-2025-12-09.md
progress/daily-update-2025-12-11.md
progress/weekly-summary-2025-w50.md
Naming Guidelines:
- Use lowercase with hyphens (kebab-case)
- Include ISO date format
YYYY-MM-DDfor time-specific reports - Use descriptive names that indicate content
- Avoid generic names like
report.mdoroutput.txt
✅ DO:
- Create all reports in this directory or appropriate subdirectory
- Use descriptive filenames with timestamps
- Include frontmatter in markdown reports for metadata
- Commit reports that provide value for future reference
❌ DON'T:
- Create report files in repository root
- Create report files in
docs/folder - Create report files in
/tmp/or other temporary locations - Use generic names like
report.txtoroutput.md
For questions about report organisation, see file-organisation.instructions.md