fix: normalize report formatting guidance across workflow prompts - #49677
Merged
pelikhan merged 2 commits intoAug 2, 2026
Conversation
1 task
Add explicit reporting guidelines (h3+ headers, <details> progressive disclosure, overview→metrics→details→actions structure) to 11 workflow files listed in issue #49580. Skip agentic-token-audit.md (upstream- managed) and files that were already compliant. Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Normalize report formatting for non-compliant workflows
fix: normalize report formatting guidance across workflow prompts
Aug 1, 2026
pelikhan
marked this pull request as ready for review
August 2, 2026 00:18
pelikhan
deleted the
copilot/workflow-style-normalize-report-formatting-0a007b04-b9d2-4d6f-a8e3-cd5d79ccd5d1
branch
August 2, 2026 00:18
Copilot stopped reviewing on behalf of
pelikhan due to an error
August 2, 2026 00:18
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot could not run the full agentic suite for this review because it was automatically requested on a bot-authored pull request. Request a review from Copilot under Reviewers to retry with the full agentic suite. Improved support for bot-authored pull requests is coming soon.
Standardizes report formatting guidance across multiple gh-aw workflow spec markdown files to enforce consistent header levels and collapsible detail sections.
Changes:
- Updated embedded report templates to avoid
#/##headings (use###or lower). - Added a consistent “Reporting Guidelines” section to multiple workflow specs.
- Regenerated gh-aw lock files to reflect updated workflow spec bodies.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/repo-audit-analyzer.md | Downgrades template headings and adds shared reporting guidelines for audit reports. |
| .github/workflows/repo-audit-analyzer.lock.yml | Updates generated metadata hashes for the workflow spec changes. |
| .github/workflows/designer-drift-audit.md | Adds reporting guidelines section and fixes list indentation. |
| .github/workflows/designer-drift-audit.lock.yml | Updates generated metadata hashes for the workflow spec changes. |
| .github/workflows/daily-spending-forecast.md | Tightens report formatting rules and details wrapper guidance. |
| .github/workflows/daily-spending-forecast.lock.yml | Updates generated metadata hashes for the workflow spec changes. |
| .github/workflows/daily-safeoutputs-git-simulator.md | Adds reporting guidelines section. |
| .github/workflows/daily-safeoutputs-git-simulator.lock.yml | Updates generated metadata hashes for the workflow spec changes. |
| .github/workflows/daily-multi-device-docs-tester.md | Adds explicit header/details formatting guidance to output format. |
| .github/workflows/daily-multi-device-docs-tester.lock.yml | Updates generated metadata hashes for the workflow spec changes. |
| .github/workflows/daily-model-resolution.md | Collapses formatting guidance into a single combined line. |
| .github/workflows/daily-model-resolution.lock.yml | Updates generated metadata hashes for the workflow spec changes. |
| .github/workflows/daily-github-docs-seo-optimizer.md | Adds reporting guidelines section. |
| .github/workflows/daily-github-docs-seo-optimizer.lock.yml | Updates generated metadata hashes for the workflow spec changes. |
| .github/workflows/daily-geo-optimizer.md | Downgrades template headings and adds explicit formatting guidance to output format. |
| .github/workflows/daily-geo-optimizer.lock.yml | Updates generated metadata hashes for the workflow spec changes. |
| .github/workflows/daily-doc-healer.md | Adds explicit header/details formatting guidance to output format. |
| .github/workflows/daily-doc-healer.lock.yml | Updates generated metadata hashes for the workflow spec changes. |
| .github/workflows/daily-cli-performance.md | Adds reporting guidelines section. |
| .github/workflows/daily-cli-performance.lock.yml | Updates generated metadata hashes for the workflow spec changes. |
| .github/workflows/daily-awf-spec-compiler-surfacing.md | Adds reporting guidelines section. |
| .github/workflows/daily-awf-spec-compiler-surfacing.lock.yml | Updates generated metadata hashes for the workflow spec changes. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 22/22 changed files
- Comments generated: 4
- Review effort level: Lite
Comment on lines
+456
to
458
| ### 🤖 GitHub Actions Analysis | ||
|
|
||
| ### Current Workflows |
|
|
||
| Use `###` or lower for all headings inside the issue body. | ||
| Wrap verbose tables in `<details><summary>…</summary>` blocks. | ||
| Use `###` or lower for all headings inside the issue body; never use `#` or `##` inside the report body. Wrap verbose tables in `<details><summary>…</summary>` blocks. Structure reports as: overview → key metrics/issues → collapsible detail → next actions. |
Comment on lines
+712
to
+716
| ## Reporting Guidelines | ||
|
|
||
| - Use `###` (h3) or lower for all report headers; never use `#` or `##` inside the report body. | ||
| - Wrap long lists, tables, and detailed findings in `<details><summary><b>...</b></summary>...</details>` blocks for progressive disclosure. | ||
| - Structure reports as: overview → key metrics/issues → collapsible detail → next actions. |
|
|
||
| ### Output Format | ||
|
|
||
| Use `###` (h3) or lower for all report headers; never use `#` or `##` inside the report body. Wrap long lists, tables, and detailed findings in `<details><summary><b>...</b></summary>...</details>` blocks for progressive disclosure. |
Contributor
|
🎉 This pull request is included in a new release. Release: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
14 workflow prompt files were missing explicit instructions for report header levels, progressive disclosure, and report structure — causing agents to generate
#/##headers and unstructured output inconsistent with the style guide.Changes
11 workflow files updated to add or expand reporting guidance with three consistent rules:
###(h3) or lower for all report headers; never#or##in report body<details><summary><b>...</b></summary>...</details>repo-audit-analyzer.mdadditionally had 13 report template headers demoted from#/##to###/####to align the template with the new guidance.daily-geo-optimizer.mdhad## GEO Audit Reportand## GEO Improvementin its report body templates corrected to###.Skipped
agentic-token-audit.mdsource: githubnext/agentic-ops@...) — read-onlyagentic-token-trend-audit.mddaily-squid-image-scan.md###/####and<details>guidancePattern added (example)
Files that already had a
### Output Formatsection (e.g.daily-doc-healer.md,daily-multi-device-docs-tester.md) had those sections expanded in-place rather than adding a duplicate section.