-
Notifications
You must be signed in to change notification settings - Fork 250
Description
Workflows to Update
The following workflows generate reports but don't follow the project's markdown style guidelines:
| Workflow File | Issues Found |
|---|---|
.github/workflows/cli-consistency-checker.md |
Issue template uses ## Summary (h2), no header level guidelines, no progressive disclosure instructions |
.github/workflows/repository-quality-improver.md |
Report template uses # Title (h1) and ## Executive Summary (h2) headers |
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. The issue/discussion title serves as h1, so start section headers at h3."
For cli-consistency-checker.md, update the issue template from:
## Summary
...
### Breakdown by Severityto:
### Summary
...
#### Breakdown by SeverityFor repository-quality-improver.md, update the report template from:
# 🎯 Repository Quality Improvement Report - [FOCUS AREA]
...
## Executive Summary
...
## Focus Area: [AREA NAME]to:
### 🎯 Repository Quality Improvement Report - [FOCUS AREA]
...
### Executive Summary
...
### Focus Area: [AREA NAME]2. Progressive Disclosure
For cli-consistency-checker.md, add explicit instructions to wrap long findings sections in <details> tags:
**Report Formatting**: Use h3 (###) or lower for all headers in the report. Wrap long sections (>5 findings) in `<details><summary><b>Section Name</b></summary>` tags to improve readability.Example structure for the issue template:
### Summary
Automated CLI consistency inspection found **X inconsistencies**...
### Breakdown by Severity
- **High**: X
- **Medium**: X
- **Low**: X
<details>
<summary><b>Detailed Findings</b></summary>
#### 1. [Issue Title]
...
</details>3. Report Structure
Both workflows should structure their output following this pattern:
- Brief summary (always visible)
- Key metrics or highlights (always visible)
- Detailed findings (in
<details>tags) - Recommendations or next steps (always visible)
Design Principles (Airbnb-Inspired)
The 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 compliant reporting workflows
Example Reference
See .github/workflows/draft-pr-cleanup.md, .github/workflows/pr-triage-agent.md, or .github/workflows/ci-doctor.md for good examples of compliant report formatting.
Agent Task
Update each workflow file listed in the table above to:
- Add a Report Formatting section in the prompt with explicit header level guidelines
- Update any embedded issue/discussion templates to use h3+ headers
- Add
<details>tag instructions for long content sections - Recompile the workflows with
make recompileafter making changes
Generated by Workflow Normalizer
- expires on Feb 24, 2026, 1:51 PM UTC