Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 23, 2026

The daily-code-metrics workflow generates discussion reports using h2 (##) headers throughout, creating incorrect document hierarchy where the discussion title should serve as h1.

Changes

  • Added formatting guidelines section documenting h3/h4 header structure and progressive disclosure pattern
  • Normalized template headers:
    • Main sections: h2 → h3 (📊 Visualizations, 💡 Insights & Recommendations)
    • Visualization subsections: h3 → h4 (LOC Distribution, Top Directories, Quality Score, etc.)
    • Detailed metrics sections (inside <details>): h2 → h3 (Size Metrics, Quality Indicators, Test Coverage, etc.)
    • Fourth-level sections: h3 → h4 (Lines of Code by Language/Directory, Component Breakdown, Most Active Files)

Document hierarchy

# Discussion Title (implicit h1)
### 📊 Visualizations (h3)
#### LOC Distribution by Language (h4)
<details>
### Size Metrics (h3)
#### Lines of Code by Language (h4)
</details>

Aligns with daily-repo-chronicle.md and improves scannability of dense metrics reports.

Original prompt

This section details on the original issue you should resolve

<issue_title>[workflow-style] Normalize report formatting for daily-code-metrics</issue_title>
<issue_description>### Workflow to Update

Workflow File: .github/workflows/daily-code-metrics.md
Issue: This workflow generates code metrics reports with extensive templates that use h2 (##) headers throughout, which should be h3 (###) for proper document hierarchy

Required Changes

Update the discussion template to use proper header levels across all sections.

1. Fix Header Levels in Main Template

The discussion template (lines 247-393) uses many ## headers which should be ###:

Main sections to update:

  • ## 📊 Visualizations### 📊 Visualizations
  • ## 💡 Insights & Recommendations### 💡 Insights & Recommendations

Subsections inside <details> to update:

  • ## Size Metrics### Size Metrics
  • ## Quality Indicators### Quality Indicators
  • ## Test Coverage### Test Coverage
  • ## Code Churn (Last 7 Days)### Code Churn (Last 7 Days)
  • ## Workflow Metrics### Workflow Metrics
  • ## Documentation### Documentation
  • ## Quality Score: XX/100### Quality Score: XX/100

Fourth-level headers:

  • ### Lines of Code by Language#### Lines of Code by Language
  • ### Lines of Code by Directory#### Lines of Code by Directory
  • ### Most Active Files#### Most Active Files
  • ### Component Breakdown#### Component Breakdown

2. Add Formatting Guidelines

Add this section before the "Report Format" heading (around line 238):

## Report Formatting Guidelines

**IMPORTANT**: Use h3 (###) or lower for all headers in the discussion report to maintain proper document hierarchy. The discussion title serves as h1.

**Structure**:
- Main sections: h3 (###) - e.g., "### 📊 Visualizations"
- Subsections: h4 (####) - e.g., "#### LOC Distribution by Language"
- Detail sections inside `<details>`: h3/h4 as appropriate

**Progressive Disclosure**: Keep executive summary and key visualizations visible. Use `<details>` tags for detailed metrics tables (as already shown in template).

3. Update All Template Headers

Systematically replace header levels in the template body (lines 247-393):

  1. All standalone #####
  2. All ### nested under sections → ####
  3. Maintain the existing <details> structure (already good)

Positive Notes:

  • This workflow already uses <details> tags excellently for "📈 Detailed Metrics"
  • The structure and organization are very clear
  • Chart generation instructions are comprehensive

Design Principles

The updated workflow will create reports that:

  1. Build trust through clarity: Proper hierarchy improves scannability of dense metrics
  2. Maintain consistency: Aligns with other daily reporting workflows
  3. Support navigation: Better structured for jumping between sections

Example Reference

See daily-repo-chronicle.md for a similar workflow that uses proper header levels throughout.

Testing

After updating:

  1. Run the workflow with workflow_dispatch
  2. Check the generated discussion for proper header hierarchy
  3. Verify the detailed metrics section inside <details> uses h3/h4 appropriately
  4. Confirm no h2 (##) headers appear in the report body

AI generated by Workflow Normalizer

  • expires on Jan 30, 2026, 12:24 PM UTC

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits January 23, 2026 22:59
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
- Add Report Formatting Guidelines section before Report Format
- Update all h2 headers to h3 in discussion template
- Update all h3 headers to h4 in subsections
- Recompile workflow to generate updated lock file

All headers now follow proper document hierarchy where discussion
title serves as h1, main sections use h3, and subsections use h4.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Update header levels in daily code metrics report Normalize header hierarchy in daily-code-metrics discussion template Jan 23, 2026
Copilot AI requested a review from pelikhan January 23, 2026 23:05
@pelikhan pelikhan marked this pull request as ready for review January 23, 2026 23:08
@pelikhan pelikhan merged commit 4031c1d into main Jan 23, 2026
@pelikhan pelikhan deleted the copilot/normalize-report-formatting branch January 23, 2026 23:08
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.

[workflow-style] Normalize report formatting for daily-code-metrics

2 participants