Skip to content

Normalize report formatting across four workflows (h3+ headers, progressive disclosure) #17377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 2 commits into from
Feb 21, 2026
Merged

Normalize report formatting across four workflows (h3+ headers, progressive disclosure) #17377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
417d47b
Initial plan
Copilot Feb 21, 2026
4a3b656
fix: normalize report formatting for pr-triage-agent, ci-doctor, cont…
Copilot Feb 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 20 additions & 10 deletions .github/workflows/ci-doctor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,39 +170,49 @@ You are the CI Failure Doctor, an expert investigative agent that analyzes faile

### Investigation Issue Template

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

When creating an investigation issue, use this structure:

```markdown
# 🏥 CI Failure Investigation - Run #${{ github.event.workflow_run.run_number }}
### CI Failure Investigation - Run #${{ github.event.workflow_run.run_number }}
Copy link

Copilot AI Feb 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This changes the investigation issue title content by removing the 🏥 emoji (not just the header level). If the intent of this PR is only formatting normalization, consider keeping the original title text and only adjusting the heading level.

Copilot uses AI. Check for mistakes.

## Summary
### Summary
[Brief description of the failure]

## Failure Details
### Failure Details
- **Run**: [${{ github.event.workflow_run.id }}](${{ github.event.workflow_run.html_url }})
- **Commit**: ${{ github.event.workflow_run.head_sha }}
- **Trigger**: ${{ github.event.workflow_run.event }}

## Root Cause Analysis
### Root Cause Analysis
[Detailed analysis of what went wrong]

## Failed Jobs and Errors
### Failed Jobs and Errors
[List of failed jobs with key error messages]

## Investigation Findings
<details>
<summary><b>Investigation Findings</b></summary>

[Deep analysis results]

## Recommended Actions
</details>

### Recommended Actions
- [ ] [Specific actionable steps]

## Prevention Strategies
### Prevention Strategies
[How to prevent similar failures]

## AI Team Self-Improvement
### AI Team Self-Improvement
[Short set of additional prompting instructions to copy-and-paste into instructions.md for a AI coding agents to help prevent this type of failure in future]

## Historical Context
<details>
<summary><b>Historical Context</b></summary>

[Similar past failures and patterns]

</details>
```

## Important Guidelines
Expand Down
9 changes: 8 additions & 1 deletion .github/workflows/contribution-check.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ Follow the **report layout rules** below — they apply to every report this wor

Apply these principles to make the report scannable, warm, and actionable:

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

1. **Lead with the takeaway.** Open with a single-sentence human-readable summary that tells the maintainer what happened and what needs attention. No jargon, no counts-only headers. Example: *"We looked at 10 new PRs — 6 look great, 3 need a closer look, and 1 doesn't fit the project guidelines."*

2. **Group by action, not by data.** Organize results into clear groups that answer "what should I do?" rather than listing raw rows. Use these groups (omit any group with zero items):
Expand All @@ -119,7 +121,7 @@ Apply these principles to make the report scannable, warm, and actionable:
### Example Report

```markdown
## Contribution Check — {date}
### Contribution Check — {date}

We looked at 4 new PRs — 1 looks great, 2 need a closer look, and 1 doesn't fit the contribution guidelines.

Expand All @@ -144,10 +146,15 @@ We looked at 4 new PRs — 1 looks great, 2 need a closer look, and 1 doesn't fi

### Off-guidelines 🔴

<details>
<summary><b>Per-PR Details</b></summary>

| PR | Title | Author | Lines | Quality |
|----|-------|--------|------:|---------|
| #4519 | Add unrelated marketing page | @dave | 42 | spam |

Copy link

Copilot AI Feb 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For GitHub-flavored Markdown, tables inside a

Details block are more reliably rendered when there’s a blank line before the closing
tag. Add an empty line between the table and to match the established pattern in .github/workflows/shared/reporting.md.

Suggested change

Copilot uses AI. Check for mistakes.
</details>

---

Evaluated: 4 · Skipped: 10
Expand Down
22 changes: 16 additions & 6 deletions .github/workflows/draft-pr-cleanup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,32 +155,42 @@ For each PR classified as "Ready to Close":

### Step 6: Generate Summary Report

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

Create a summary of actions taken:

```markdown
## 🧹 Draft PR Cleanup Summary
### 🧹 Draft PR Cleanup Summary

**Run Date**: <date>

### Statistics
#### Statistics
- **Total Draft PRs**: <count>
- **Exempt from Cleanup**: <count> (keep-draft, blocked, or awaiting-review)
- **Active (< 10 days)**: <count>
- **Warned (10-13 days)**: <count>
- **Closed (14+ days)**: <count>

### Actions Taken
#### Actions Taken
- **New Warnings Added**: <count>
- **PRs Closed**: <count>
- **PRs Skipped (exempt)**: <count>

### PRs Warned This Run
<details>
<summary><b>PRs Warned This Run</b></summary>

<list of PR numbers with titles>

### PRs Closed This Run
</details>

<details>
<summary><b>PRs Closed This Run</b></summary>

<list of PR numbers with titles and days inactive>

### Next Steps
</details>

#### Next Steps
- Draft PRs currently in warning phase will be reviewed again tomorrow
- Authors can prevent closure by adding activity or the `keep-draft` label
- Closed PRs can be reopened if work continues
Expand Down
46 changes: 30 additions & 16 deletions .github/workflows/pr-triage-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ For each PR, add the following labels:
For each triaged PR, add a comment with the triage results:

```markdown
## 🔍 PR Triage Results
### 🔍 PR Triage Results

**Category:** {category} | **Risk:** {risk} | **Priority:** {priority_score}/100
Comment on lines +254 to 256
Copy link

Copilot AI Feb 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lowering the PR comment title to h3 makes the existing subsections (e.g., "Scores Breakdown" / "Recommended Action") the same header level as the title, which flattens the hierarchy. Consider demoting those subsections to h4 so they’re clearly nested under "PR Triage Results" while still staying at h3+ overall.

See below for a potential fix:

#### Scores Breakdown
- **Impact:** {impact_score}/50 - {impact_rationale}
- **Urgency:** {urgency_score}/30 - {urgency_rationale}
- **Quality:** {quality_score}/20 - {quality_rationale}

#### 📋 Recommended Action: {action}

Copilot uses AI. Check for mistakes.

Expand All @@ -274,12 +274,14 @@ For each triaged PR, add a comment with the triage results:

Create a comprehensive triage report as a GitHub Issue:

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

**Report Structure:**

```markdown
# PR Triage Report - {date}
### PR Triage Report - {date}

## Executive Summary
### Executive Summary

- **Total PRs Triaged:** {count}
- **New PRs:** {new_count}
Expand All @@ -289,9 +291,11 @@ Create a comprehensive triage report as a GitHub Issue:
- **Batches Identified:** {batch_count}
- **Close Candidates:** {close_count}

## Triage Statistics
### Triage Statistics

<details>
<summary><b>By Category</b></summary>

### By Category
- Bug: {bug_count}
- Feature: {feature_count}
- Docs: {docs_count}
Expand All @@ -300,52 +304,62 @@ Create a comprehensive triage report as a GitHub Issue:
- Refactor: {refactor_count}
- Chore: {chore_count}

### By Risk Level
</details>

<details>
<summary><b>By Risk Level</b></summary>

- High Risk: {high_risk_count}
- Medium Risk: {medium_risk_count}
- Low Risk: {low_risk_count}

### By Priority
</details>

<details>
<summary><b>By Priority</b></summary>

- High Priority (70-100): {high_priority_count}
- Medium Priority (40-69): {medium_priority_count}
- Low Priority (0-39): {low_priority_count}

### By Recommended Action
</details>

#### By Recommended Action
- Auto-merge: {auto_merge_count}
- Fast-track: {fast_track_count}
- Batch Review: {batch_review_count}
- Defer: {defer_count}
- Close: {close_count}

## 🚀 Top Priority PRs (Top 10)
### 🚀 Top Priority PRs (Top 10)

{list_top_10_prs_with_scores_and_links}

## ✅ Auto-merge Candidates
### ✅ Auto-merge Candidates

{list_auto_merge_prs}

## ⚡ Fast-track Review Needed
### ⚡ Fast-track Review Needed

{list_fast_track_prs}

## 📦 Batch Processing Opportunities
### 📦 Batch Processing Opportunities

{list_batches_with_pr_numbers}

## 🗑️ Close Candidates
### 🗑️ Close Candidates

{list_close_candidate_prs_with_reasons}

## 📊 Agent Performance Summary
### 📊 Agent Performance Summary

{summary_of_prs_by_agent_with_quality_scores}

## 🔄 Trends
### 🔄 Trends

{compare_to_previous_runs_if_available}

## Next Steps
### Next Steps

1. Review auto-merge candidates for immediate merge
2. Fast-track high-priority PRs for urgent review
Expand Down