Skip to content

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

@github-actions

Description

@github-actions

Workflows to Update

The following workflows generate reports but have embedded templates that don't follow the markdown style guidelines (even though shared/reporting.md is imported):

Workflow File Issues Found
.github/workflows/pr-nitpick-reviewer.md Report template uses # (h1) and ## (h2) headers, contradicting shared/reporting.md guidelines

Details

pr-nitpick-reviewer.md imports shared/reporting.md which specifies "Never use ## (h2) or # (h1) in reports", but the inline discussion report template in Step 5 uses non-compliant headers:

# PR Nitpick Review Summary - [DATE]   ← h1 ❌

## Pull Request Overview               ← h2 ❌
## Nitpick Categories                  ← h2 ❌
## Pattern Analysis                    ← h2 ❌
## Positive Highlights                 ← h2 ❌
## Recommendations                     ← h2 ❌
## Learning Resources                  ← h2 ❌

Additionally, the inline PR review comment body example uses ## Overall Observations (h2).

Required Changes

Update the discussion report template in pr-nitpick-reviewer.md to use h3 (###) or lower:

1. Fix the Discussion Report Template (Step 5)

Replace all # and ## headers in the template with ### and ####:

### PR Nitpick Review Summary - [DATE]   ← h3 ✅

#### Pull Request Overview               ← h4 ✅
#### Nitpick Categories                  ← h4 ✅
#### Pattern Analysis                    ← h4 ✅
#### Positive Highlights                 ← h4 ✅
#### Recommendations                     ← h4 ✅
#### Learning Resources                  ← h4 ✅

2. Fix the Inline PR Review Comment Body Example

Replace ## Overall Observations with ### Overall Observations in the review body example at Step 4.

3. Ensure Progressive Disclosure Is Applied

The template already wraps content in <details> tags - confirm that long section content remains wrapped.

Report Structure Reference

Per shared/reporting.md:

  • Use ### (h3) for main sections
  • Use #### (h4) for subsections
  • Never use ## (h2) or # (h1) in reports - these are reserved for titles

Design Principles (Airbnb-Inspired)

The updated workflow should create reports that:

  1. Build trust through clarity: Most important info immediately visible
  2. Exceed expectations: Add helpful context, trends, comparisons
  3. Create delight: Use progressive disclosure to reduce overwhelm
  4. Maintain consistency: Follow the same patterns as other reporting workflows

Compliance Context

This review covered 11 active workflows from the last 24 hours. 10 of 11 are already compliant — only pr-nitpick-reviewer.md needs attention.

Compliant workflows (no action needed):

  • cli-consistency-checker.md
  • daily-file-diet.md
  • ci-doctor.md
  • step-name-alignment.md
  • auto-triage-issues.md
  • repository-quality-improver.md
  • contribution-check.md
  • draft-pr-cleanup.md

References: §22720676363

Generated by Workflow Normalizer ·

  • expires on Mar 6, 2026, 1:51 PM UTC

Metadata

Metadata

Assignees

No one assigned

    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