Skip to content

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

@github-actions

Description

@github-actions

Workflows to Update

The following workflows were active in the last 24 hours and generate reports/comments, but their output format instructions use incorrect header levels (# or ##) and lack <details> progressive disclosure guidance:

Workflow File Issues Found
.github/workflows/cloclo.md Output template uses h2 (## ✨ Claude Response via '/cloclo'); missing <details> guidance
.github/workflows/q.md Output template uses h1/h2 (# Q Workflow Optimization Report, ## Issues Found); missing <details> guidance
.github/workflows/plan.md Sub-issue body template uses h2 (## Objective, ## Context); missing <details> guidance

Required Changes

For each workflow listed above, update the output format instructions to include these formatting guidelines:

1. Header Levels

Replace # and ## headers in report/comment/issue body templates with ### and ####:

  • ## ✨ Claude Response via '/cloclo' → ✅ ### ✨ Claude Response via '/cloclo'
  • # Q Workflow Optimization Report → ✅ ### Q Workflow Optimization Report
  • ## Issues Found → ✅ ### Issues Found
  • ## Objective / ## Context in issue bodies → ✅ ### Objective / ### Context

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

2. Progressive Disclosure

Add instruction to wrap long or repetitive sections in <details> tags:

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

[Verbose content here...]

</details>

This is especially important for:

  • cloclo: Long "Details" and "Changes Made" sections
  • q: Per-workflow analysis in the PR description
  • plan: When more than 3 sub-issues are being described

3. Import shared/reporting.md

The simplest fix: add shared/reporting.md to the imports: section of each workflow's frontmatter. This shared file already contains all formatting guidelines and is imported by 66 of 110 reporting workflows.

imports:
  - shared/reporting.md

Design Principles (Airbnb-Inspired)

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 archie, test-quality-sentinel, and design-decision-gate which already follow these guidelines

Good Reference Examples

Workflows that already follow style guidelines:

  • archie.md: Explicitly states "Use h3 (###) or lower for all headers" and uses <details> for additional diagrams
  • test-quality-sentinel.md: Uses ### 🧪 Test Quality Sentinel Report and <details> for classification tables
  • design-decision-gate.md: Uses ### ✅ Design Decision Gate — ADR Approved in all comment templates

Agent Task

For each workflow file listed in the table above:

  1. Add shared/reporting.md to imports: in the frontmatter
  2. Update all output/comment/issue body format templates to use ### or #### (never # or ##)
  3. Add <details><summary><b>...</b></summary> wrapping for any section longer than ~10 lines

References: §24484436095

Note

🔒 Integrity filter blocked 2 items

The following items were blocked because they don't meet the GitHub integrity level.

  • #19611 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #19080 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".

To allow these resources, lower min-integrity in your GitHub frontmatter:

tools:
  github:
    min-integrity: approved  # merged | approved | unapproved | none

Generated by Workflow Normalizer · ● 2.6M ·

  • expires on Apr 17, 2026, 12:05 AM UTC

Metadata

Metadata

Assignees

No one assigned

    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