Skip to content

[workflow-style] Normalize report formatting for non-compliant workflows #47576

Description

@github-actions

Overview

Automated style normalization scan (2026-07-23) reviewed 22 reporting/daily/weekly workflows for compliance with markdown formatting guidelines. 3 workflows were found to demonstrate correct header patterns in their output examples but lack an explicit enforcement instruction (e.g. "Use h3 (###) or lower for all headers").

Non-Compliant Workflows

Workflow File Issue Priority
.github/workflows/detection-analysis-report.md Has ## Report Structure section demonstrating ### but no explicit "use h3 or lower" enforcement text Medium
.github/workflows/daily-reliability-review.md Output body structure uses ### correctly, but no explicit h3 enforcement instruction Medium
.github/workflows/daily-team-evolution-insights.md Uses ### and <details> throughout, but lacks explicit h3 enforcement guidance Low

Required Changes

For each workflow, add an explicit formatting instruction. Good reference text to add (e.g. in a "Formatting" or "Guidelines" section):

**Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in `<details><summary>Section Name</summary>` tags to improve readability and reduce scrolling.

Or reference the shared spec:

Follow the **Report Formatting Guidelines** in `shared/reporting.md` to structure your report with:
- h3 (###) for main section headers
- Detailed lists wrapped in `<details>` tags
- Critical information (overview, trends, recommendations) always visible

Example: Progressive Disclosure Pattern

Before / After Example

Before (non-explicit):

## Report Structure
### Summary
### Findings

After (with explicit enforcement):

## Report Structure

**Report Formatting**: Use h3 (###) or lower for all headers. Wrap verbose sections in `<details>` tags.

### Summary
### Findings
<details><summary>View All Items</summary>
...
</details>

Good Reference Examples

  • .github/workflows/audit-workflows.md — has **Report Formatting**: Use h3 (###) or lower... guidance
  • .github/workflows/weekly-issue-summary.md — references shared/reporting.md
  • .github/workflows/daily-performance-summary.md — full output template with ### Performance Overview

Compliance Summary

  • Compliant: 19 workflows already follow style guidelines
  • ⚠️ Needs Improvement: 3 workflows need explicit h3 enforcement text added

Next Steps

  • Add explicit h3 formatting instruction to detection-analysis-report.md
  • Add explicit h3 formatting instruction to daily-reliability-review.md
  • Add explicit h3 formatting instruction to daily-team-evolution-insights.md
  • Re-run normalization scan after changes to confirm compliance

Generated by 🔧 Workflow Normalizer · sonnet46 47 AIC · ⌖ 7.62 AIC · ⊞ 7.3K ·

  • expires on Jul 24, 2026, 5:18 AM UTC-08:00

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

cookieIssue Monster Loves Cookies!enhancementNew feature or request

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions