Normalize report formatting guidelines across daily workflow prompts#28649
Normalize report formatting guidelines across daily workflow prompts#28649
Conversation
…, and daily-safe-output-integrator workflows Agent-Logs-Url: https://github.com/github/gh-aw/sessions/7c0e0e61-d20e-4295-8d66-03575a02e911 Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
|
Hey This repository doesn't have a
|
There was a problem hiding this comment.
Pull request overview
Normalizes daily workflow prompt guidance by adding a consistent “Report Formatting” instruction to previously divergent reporting workflows, aiming to standardize header hierarchy and encourage progressive disclosure.
Changes:
- Added a “Report Formatting” guideline to
audit-workflows.mdunder## Guidelines. - Inserted the same guideline into
daily-regulatory.mdunder### Discussion Format. - Added the guideline to
daily-safe-output-integrator.mdin the Phase 7 PR/report creation step.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/daily-safe-output-integrator.md | Adds report/PR formatting guidance during PR/report creation. |
| .github/workflows/daily-regulatory.md | Adds standardized report formatting rule to the discussion template section. |
| .github/workflows/audit-workflows.md | Appends report formatting instruction to the general workflow guidelines. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 3/3 changed files
- Comments generated: 2
| **Security**: Never execute untrusted code, validate data, sanitize paths | ||
| **Quality**: Be thorough, specific, actionable, accurate | ||
| **Efficiency**: Use repo memory, batch operations, respect timeouts | ||
| **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in `<details><summary>Section Name</summary>` tags to improve readability and reduce scrolling. |
There was a problem hiding this comment.
In this ## Guidelines section, these guideline lines are plain paragraphs (not a list), and most of them don’t end with Markdown hard line breaks. In CommonMark/GitHub, the new **Report Formatting** line will render in the same paragraph as the preceding guideline (likely concatenating with **Efficiency**), which hurts readability. Consider converting the Guidelines block to a bulleted list (as used in other workflows like .github/workflows/api-consumption-report.md:433-441) or adding consistent hard line breaks so each guideline renders on its own line.
| **Security**: Never execute untrusted code, validate data, sanitize paths | |
| **Quality**: Be thorough, specific, actionable, accurate | |
| **Efficiency**: Use repo memory, batch operations, respect timeouts | |
| **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in `<details><summary>Section Name</summary>` tags to improve readability and reduce scrolling. | |
| - **Security**: Never execute untrusted code, validate data, sanitize paths | |
| - **Quality**: Be thorough, specific, actionable, accurate | |
| - **Efficiency**: Use repo memory, batch operations, respect timeouts | |
| - **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in `<details><summary>Section Name</summary>` tags to improve readability and reduce scrolling. |
|
|
||
| ## Phase 7: Create PR or Report NOOP | ||
|
|
||
| - **Report Formatting**: Use h3 (###) or lower for all headers in your PR body and report content to maintain proper document hierarchy. Wrap long sections in `<details><summary>Section Name</summary>` tags to improve readability and reduce scrolling. |
There was a problem hiding this comment.
PR description says the added guideline “matches daily-performance-summary.md pattern”, but this instance changes the wording to “headers in your PR body and report content”. If the goal is strict normalization, align the wording with the shared pattern ("headers in your report") or update the PR description to explicitly call out this intentional variation.
Three daily reporting workflows lacked the standard markdown formatting instructions already present in
daily-performance-summary.md, leading to inconsistent report structure across automated discussions and PRs.Changes
audit-workflows.md— Appended formatting guideline to## Guidelinessection (header levels + progressive disclosure)daily-regulatory.md— Inserted formatting guideline into### Discussion Formatsection (header levels)daily-safe-output-integrator.md— Added formatting guideline to## Phase 7PR creation section (header levels + progressive disclosure)Guideline added (matches
daily-performance-summary.mdpattern)