Skip to content

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

@github-actions

Description

@github-actions

Workflows to Update

The following active workflows generate reports but don't include complete markdown style guidelines for proper header levels and progressive disclosure:

Workflow File Issues Found
.github/workflows/ai-moderator.md Missing header level guidelines and progressive disclosure instructions
.github/workflows/chaos-pr-bundle-fuzzer.md Missing report structure guidelines
.github/workflows/daily-token-consumption-report.md Missing progressive disclosure requirement
.github/workflows/design-decision-gate.md Missing report formatting guidelines
.github/workflows/github-mcp-structural-analysis.md Incomplete formatting specification (missing progressive disclosure requirement)
.github/workflows/pr-code-quality-reviewer.md Missing report formatting guidelines
.github/workflows/pr-sous-chef.md Missing formatting guidelines for comments
.github/workflows/test-quality-sentinel.md Missing explicit formatting guidelines

Required Changes

For each workflow listed above, update the prompt to include these formatting guidelines:

1. Header Levels

Add instruction: "Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy."

Rationale: GitHub issues and discussions reserve h1 (#) for the title and h2 (##) for system-generated sections. User-generated content should start at h3 to avoid breaking the visual hierarchy.

2. Progressive Disclosure

Add instruction: "Wrap long sections in <details><summary>Section Name</summary> tags to improve readability and reduce scrolling."

Example:

<details>
<summary>Full Analysis Details</summary>

[Long detailed content here...]

</details>

Rationale: Progressive disclosure keeps key information visible while hiding verbose details until needed, creating a better user experience and reducing information overwhelm.

3. Report Structure

Suggest a structure like:

  • Brief summary (always visible)
  • Key metrics or highlights (always visible)
  • Detailed analysis (in <details> tags)
  • Recommendations (always visible)

Design Principles (Airbnb-Inspired)

The updated workflows 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

Example Reference

Workflows that already follow these guidelines and can serve as examples:

  • daily-reliability-review.md - Excellent use of progressive disclosure with <details> tags
  • auto-triage-issues.md - Complete report formatting guidelines including h3+ headers
  • claude-code-user-docs-review.md - Explicitly documents using h3+ headers and collapsible sections

Success Criteria

✅ Each workflow prompt includes explicit header level guidelines (h3+)
✅ Each workflow prompt includes progressive disclosure instructions with <details> tags
✅ Each workflow prompt suggests a clear report structure (summary → details → recommendations)
✅ Guidelines are placed prominently in the prompt (not buried in boilerplate)

Notes

  • This normalization effort focuses on user-facing report formatting to improve readability and consistency
  • These changes align with Airbnb's design principles: clarity, exceeding expectations, and delightful experiences
  • Progressive disclosure is particularly important for workflows that generate large reports or detailed analyses

Generated by 🔧 Workflow Normalizer · ● 5.6M ·

  • expires on May 21, 2026, 1:43 PM UTC

Metadata

Metadata

Labels

automationcookieIssue Monster Loves Cookies!documentationImprovements or additions to documentation

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions