-
Notifications
You must be signed in to change notification settings - Fork 50
Description
Workflow File: .github/workflows/copilot-pr-merged-report.md
This workflow generates reports tracking merged Copilot PRs but doesn't include markdown style guidelines, which can lead to inconsistent formatting and poor readability in discussions.
Required Changes
Update the workflow 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 discussion title serves as h1, so all content headers should start at h3:
- Use
###for main sections (e.g., "### Merged PR Summary", "### Key Changes") - Use
####for subsections (e.g., "#### Notable Features", "#### Bug Fixes") - Never use
##(h2) or#(h1) in the report body
2. Progressive Disclosure
Add instruction: "Wrap long sections in <details><summary><b>Section Name</b></summary> tags to improve readability and reduce scrolling."
Use collapsible sections for:
- Full PR lists and detailed descriptions
- Per-PR commit histories
- Verbose code change summaries
- Complete review comment threads
Example:
<details>
<summary><b>Full PR Details</b></summary>
[Long list of PRs with descriptions...]
</details>3. Report Structure
Suggest a structure like:
- Brief summary (always visible): Count of merged PRs, key highlights
- Key statistics and insights (always visible): Merge rate, top contributors, notable patterns
- Detailed PR breakdowns (in
<details>tags): Per-PR analysis, commit details, review discussions - Recommendations (always visible): Actionable insights for process improvement
Design Principles (Airbnb-Inspired)
The updated workflow should create reports that:
- Build trust through clarity: Most important info (summary stats, critical merges) immediately visible
- Exceed expectations: Add helpful context like merge trends, comparison to previous periods
- Create delight: Use progressive disclosure to reduce overwhelm for detailed PR data
- Maintain consistency: Follow the same patterns as other reporting workflows
Example Reference
See workflows like daily-repo-chronicle.md or audit-workflows.md for good examples of structured reporting with proper header levels and progressive disclosure.
Agent Task
Update the workflow file .github/workflows/copilot-pr-merged-report.md to include the formatting guidelines above in the prompt instructions. Test the updated workflow to ensure it produces well-formatted reports.
AI generated by Workflow Normalizer
- expires on Feb 9, 2026, 12:31 PM UTC