Skip to content

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

@github-actions

Description

@github-actions

Workflows to Update

The following workflows generate reports but don't fully include markdown style guidelines:

Workflow File Issues Found
.github/workflows/github-mcp-tools-report.md Report template uses # and ## headers (h1/h2); no <details> progressive disclosure; no formatting guidelines in prompt
.github/workflows/ab-testing-advisor.md Has ### header guidelines but missing progressive disclosure (<details>) instructions

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."

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>

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

See workflows like agent-performance-analyzer, test-quality-sentinel, and pr-code-quality-reviewer for good examples of structured reporting with h3 guidelines and progressive disclosure.

Specific Changes Needed

github-mcp-tools-report.md

The Phase 4 report template currently uses # (h1) for the main title and ## (h2) for sections like ## Executive Summary, ## Inconsistency Detection, etc. These should be downgraded to ### and #### respectively.

Also add formatting guidelines to the prompt preamble:

Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy.
Wrap long sections (e.g., full tool tables, change details) in `<details><summary>Section Name</summary>` tags to improve readability.

ab-testing-advisor.md

Already has ### header guidelines. Add progressive disclosure instruction:

Wrap long analysis sections in `<details><summary>View Details</summary>` tags to keep the issue body scannable.

Agent Task

Update each workflow file listed in the table above to include the formatting guidelines in the prompt instructions. Test the updated workflows to ensure they produce well-formatted reports.

Generated by 🔧 Workflow Normalizer · ● son46 1.6M ·

  • expires on May 25, 2026, 1:13 PM UTC

Metadata

Metadata

Labels

cookieIssue Monster Loves Cookies!

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