Skip to content

Normalize report formatting guidelines across daily workflow prompts #28649

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
Apr 27, 2026
+5 −0
Merged

Normalize report formatting guidelines across daily workflow prompts #28649

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
82f0f82
Initial plan
Copilot Apr 27, 2026
cfc670f
Add report formatting guidelines to audit-workflows, daily-regulatory…
Copilot Apr 27, 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
1 change: 1 addition & 0 deletions .github/workflows/audit-workflows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ Output is saved to: /tmp/gh-aw/aw-mcp/logs
**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.
Comment on lines 89 to +92
Copy link

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

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

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.

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

Copilot uses AI. Check for mistakes.

Memory structure: `/tmp/gh-aw/repo-memory/default/{audits,patterns,metrics}/*.json`

Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/daily-regulatory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,8 @@ Create a comprehensive discussion report with findings.

### Discussion Format

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

**Title**: `[daily regulatory] Regulatory Report - YYYY-MM-DD`

**Body**:
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/daily-safe-output-integrator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -668,6 +668,8 @@ git diff --name-only

## 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.
Copy link

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.

### If files were created:

Create a pull request with all the new test workflows and Go tests.
Expand Down
Loading