-
Notifications
You must be signed in to change notification settings - Fork 250
Closed
Labels
cookieIssue Monster Loves Cookies!Issue Monster Loves Cookies!
Description
Workflows to Update
The following workflows generate reports but use h1/h2 headers and lack progressive disclosure guidelines:
| Workflow File | Issues Found |
|---|---|
.github/workflows/pr-triage-agent.md |
Report template uses # PR Triage Report (h1) and ## Executive Summary, ## Triage Statistics, etc. (h2); no <details> tags |
.github/workflows/ci-doctor.md |
Issue template uses # 🏥 CI Failure Investigation (h1) and ## Summary, ## Root Cause Analysis, etc. (h2); no <details> tags |
.github/workflows/contribution-check.md |
Example report uses ## Contribution Check — {date} (h2) as top-level header; no <details> progressive disclosure |
.github/workflows/draft-pr-cleanup.md |
Comment template uses ## 🧹 Draft PR Cleanup Summary (h2) and ### Statistics; no <details> tags |
Required Changes
For each workflow listed above, update the embedded report/issue/comment template to follow these formatting guidelines:
1. Header Levels
Replace all # (h1) and ## (h2) headers in report output templates with ### (h3) or lower.
- ❌
# PR Triage Report - {date}→ ✅### PR Triage Report - {date} - ❌
## Executive Summary→ ✅### Executive Summary - ❌
# 🏥 CI Failure Investigation→ ✅### CI Failure Investigation - ❌
## Contribution Check — {date}→ ✅### Contribution Check — {date} - ❌
## 🧹 Draft PR Cleanup Summary→ ✅### Draft PR Cleanup Summary
2. Progressive Disclosure
Wrap long or verbose sections in <details> tags to improve readability:
<details>
<summary><b>Full Analysis Details</b></summary>
[Long detailed content here, e.g. per-PR breakdown, investigation findings...]
</details>Candidates for wrapping:
- pr-triage-agent.md: Wrap "By Category", "By Risk Level", "By Priority" breakdowns
- ci-doctor.md: Wrap "Investigation Findings" and "Historical Context"
- contribution-check.md: Wrap the per-PR detailed verdicts table when there are many PRs
- draft-pr-cleanup.md: Wrap "PRs Warned This Run" and "PRs Closed This Run" lists
3. Add Style Instructions to Prompt
Also add an explicit formatting instruction paragraph before the report template, e.g.:
**Report Formatting**: Use h3 (###) or lower for all headers in the report. Wrap long sections (>10 items) in `<details><summary><b>Section Name</b></summary>` tags to improve readability.
Design Principles (Airbnb-Inspired)
Updated workflows should create reports that:
- Build trust through clarity: Most important info immediately visible
- Exceed expectations: Add helpful context, trends, comparisons
- Create delight: Use progressive disclosure to reduce overwhelm
- Maintain consistency: Follow the same patterns as other reporting workflows
Reference — Compliant Workflows
See these workflows for good examples of structured reporting:
daily-file-diet.md— Explicit h3+ and<details>guidelines ✅ci-coach.md— Explicit h3+ and<details>guidelines ✅
Agent Task
Update each workflow file listed in the table above to:
- Replace h1/h2 headers in report templates with h3+
- Add
<details>wrapping for long sections - Add a formatting instruction to the prompt
- Run
make recompileafter each change to regenerate lock files
Generated by Workflow Normalizer
- expires on Feb 21, 2026, 1:49 PM UTC
Reactions are currently unavailable
Metadata
Metadata
Labels
cookieIssue Monster Loves Cookies!Issue Monster Loves Cookies!