Skip to content

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

@github-actions

Description

@github-actions

Workflows to Update

The following workflow generates reports but has a conflicting h2 header example and no explicit header-level guideline:

Workflow File Issues Found
.github/workflows/daily-code-metrics.md Missing explicit header-level guideline; conflicting h2 example in embed section

Required Changes

1. Add Explicit Header Level Instruction

In the ## Report Format### Discussion Structure section, add this instruction before the report template:

**Report Formatting**: Use h3 (###) or lower for all headers in the report to maintain proper document hierarchy. The discussion title serves as h1, so start section headers at h3.

2. Fix Conflicting h2 Example

In the "Embed in discussion report" code block (under ### Chart Upload and Embedding), the example currently shows:

## 📊 Visualizations      ← ❌ h2, violates style guidelines

Change it to:

### 📊 Visualizations     ← ✅ h3

This removes the conflict with the main report template further down (which already correctly uses ### 📊 Visualizations).

Context

The other active reporting workflows (daily-file-diet, ci-coach, cli-consistency-checker, repository-quality-improver, draft-pr-cleanup, auto-triage-issues, step-name-alignment, contribution-check) all include an explicit **Report Formatting**: Use h3 (###)... line. daily-code-metrics.md is the one exception.

Design Principles (Airbnb-Inspired)

Updated workflows create reports that:

  1. Build trust through clarity: Important info at h3+ keeps document hierarchy intact
  2. Maintain consistency: Same formatting patterns as all other reporting workflows

References: §22671867548

Generated by Workflow Normalizer ·

  • expires on Mar 5, 2026, 1:47 PM UTC

Metadata

Metadata

Assignees

No one assigned

    Labels

    cookieIssue Monster Loves Cookies!documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions