Skip to content

Commit f0bd8f1

Browse files
authored
Normalize report-formatting guidance across reporting workflows (#33335)
1 parent aac1b3e commit f0bd8f1

3 files changed

Lines changed: 39 additions & 0 deletions

File tree

.github/workflows/issue-monster.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -631,6 +631,19 @@ Issue Monster runs frequently (every 30 minutes), so keeping each run lean is cr
631631
-**Skip integrity-blocked issues**: If `issue_read` is blocked by integrity policy, skip that issue and continue — never call `missing_data` for integrity errors
632632
-**Don't force batching**: If only 1-2 clearly separate issues exist, assign only those
633633

634+
## Formatting Requirements
635+
636+
- **Header Levels**: Use h3 (`###`) or lower for all headers in your report to maintain proper document hierarchy. Never use h1 (`#`) or h2 (`##`) headers.
637+
- **Progressive Disclosure**: Wrap long sections or verbose details in `<details><summary>Section Name</summary>` tags to improve readability and reduce scrolling.
638+
- Keep critical information visible (summary, key outcomes, and recommendations) and use collapsible sections for secondary details.
639+
640+
### Recommended Report Structure
641+
642+
1. **Overview**: 1-2 paragraphs summarizing key findings (always visible)
643+
2. **Critical Information**: Key metrics, status, critical issues (always visible)
644+
3. **Details**: Use `<details><summary>Section Name</summary>` for expanded content
645+
4. **Recommendations**: Actionable next steps (always visible)
646+
634647
## Success Criteria
635648

636649
A successful run means:

.github/workflows/pr-sous-chef.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,19 @@ At the end, call **exactly one** `noop` with a compact summary including counts
234234
- branch_update_attempts
235235
- formatter_pushes (number of PRs that had formatting fixes committed and pushed)
236236

237+
## Formatting Requirements
238+
239+
- **Header Levels**: Use h3 (`###`) or lower for all headers in your report to maintain proper document hierarchy. Never use h1 (`#`) or h2 (`##`) headers.
240+
- **Progressive Disclosure**: Wrap long sections or verbose details in `<details><summary>Section Name</summary>` tags to improve readability and reduce scrolling.
241+
- Keep critical information visible (summary, key outcomes, and recommendations) and use collapsible sections for secondary details.
242+
243+
### Recommended Report Structure
244+
245+
1. **Overview**: 1-2 paragraphs summarizing key findings (always visible)
246+
2. **Critical Information**: Key metrics, status, critical issues (always visible)
247+
3. **Details**: Use `<details><summary>Section Name</summary>` for expanded content
248+
4. **Recommendations**: Actionable next steps (always visible)
249+
237250
## agent: `pr-processor`
238251
---
239252
description: Processes one PR with minimal API calls and returns skip/nudge decisions

.github/workflows/smoke-ci.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,5 +89,18 @@ For scheduled runs (non-pull_request), use GitHub MCP to find the newest open pu
8989
- If one exists, call `update_pull_request` for that PR number with `operation: "append"` and a short body line including the run URL.
9090
- If none exists, call `noop` with a short message indicating no PR was available.
9191

92+
## Formatting Requirements
93+
94+
- **Header Levels**: Use h3 (`###`) or lower for all headers in your report to maintain proper document hierarchy. Never use h1 (`#`) or h2 (`##`) headers.
95+
- **Progressive Disclosure**: Wrap long sections or verbose details in `<details><summary>Section Name</summary>` tags to improve readability and reduce scrolling.
96+
- Keep critical information visible (summary, key outcomes, and recommendations) and use collapsible sections for secondary details.
97+
98+
### Recommended Report Structure
99+
100+
1. **Overview**: 1-2 paragraphs summarizing key findings (always visible)
101+
2. **Critical Information**: Key metrics, status, critical issues (always visible)
102+
3. **Details**: Use `<details><summary>Section Name</summary>` for expanded content
103+
4. **Recommendations**: Actionable next steps (always visible)
104+
92105
Do not run any shell commands.
93106
Do not call any tools other than `cache-memory`, `repo-memory`, `github`, `create_issue`, `update_issue`, `add_comment`, `add_labels`, `remove_labels`, `update_pull_request`, or `noop`.

0 commit comments

Comments
 (0)