Conversation
This was referenced Mar 1, 2026
…hared/reporting.md - Removed ~1,522 lines of redundant formatting guidelines across 33 workflow files - For files with standard-format guidelines: removed heading through 'Maintain consistency' bullet, preserving workflow-specific content (templates, phase instructions) that followed - For files with brief bold-text guidelines without standard subsections: removed entire section - Restored Phase 6 content in org-health-report.md (was inside the removed section) - Updated stale references in cli-version-checker.md and weekly-issue-summary.md - All workflows already import shared/reporting.md directly or transitively - Verified all 162 workflow files compile successfully via make recompile Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Refactor workflows to remove duplicate reporting guidelines
Remove inline reporting guidelines from 33 workflows duplicating shared/reporting.md
Mar 1, 2026
Contributor
|
Hey One thing to confirm before moving out of draft:
If you'd like a hand with the final validation, you can assign this prompt to your coding agent:
|
pelikhan
approved these changes
Mar 1, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Removes duplicated inline “Report Formatting Guidelines” sections from many workflow prompt files and relies on the shared reporting guidance instead, reducing maintenance overhead.
Changes:
- Deleted redundant inline reporting-guidelines blocks across 33 workflow markdown files.
- Updated a couple of in-file references to point to
shared/reporting.mdinstead of “the section above”. - Unnested/extracted
org-health-report.mdPhase 6 content so it remains a proper workflow step after guideline removal.
Reviewed changes
Copilot reviewed 33 out of 33 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/weekly-issue-summary.md | Removes inline guidelines and updates the report-formatting reference to shared/reporting.md. |
| .github/workflows/static-analysis-report.md | Removes inline report-formatting guidance before “Phase 5” discussion creation. |
| .github/workflows/org-health-report.md | Removes inline guidelines and leaves “Phase 6: Create Discussion Report” as a standalone phase step. |
| .github/workflows/daily-testify-uber-super-expert.md | Removes duplicated inline guidelines while preserving the workflow-specific issue template. |
| .github/workflows/daily-team-status.md | Removes duplicated inline guidelines from the daily status prompt. |
| .github/workflows/daily-team-evolution-insights.md | Removes duplicated inline guidelines from the evolution-insights workflow prompt. |
| .github/workflows/daily-syntax-error-quality.md | Removes duplicated inline guidelines from the “Create Issue with Suggestions” phase. |
| .github/workflows/daily-secrets-analysis.md | Removes duplicated inline guidelines from the discussion-report generation section. |
| .github/workflows/daily-safe-outputs-conformance.md | Removes duplicated inline guidelines prior to generating agentic tasks/issues. |
| .github/workflows/daily-safe-output-optimizer.md | Removes duplicated inline guidelines in the output requirements area. |
| .github/workflows/daily-repo-chronicle.md | Removes duplicated inline guidelines from the chronicle workflow prompt. |
| .github/workflows/daily-regulatory.md | Removes duplicated inline report-formatting guidance from the regulatory review prompt. |
| .github/workflows/daily-performance-summary.md | Removes the inline “Phase 5.5” formatting section before discussion creation. |
| .github/workflows/daily-observability-report.md | Removes duplicated inline guidelines near the top of the workflow prompt. |
| .github/workflows/daily-news.md | Removes duplicated inline report-formatting guidelines while keeping workflow-specific instructions intact. |
| .github/workflows/daily-multi-device-docs-tester.md | Removes duplicated inline guidelines from the “If Issues ARE Found” section. |
| .github/workflows/daily-mcp-concurrency-analysis.md | Removes duplicated inline guidelines from the output requirements area. |
| .github/workflows/daily-firewall-report.md | Removes duplicated inline guidelines from the firewall report prompt. |
| .github/workflows/daily-compiler-quality.md | Removes duplicated inline report-formatting guidance before the discussion title/template. |
| .github/workflows/daily-code-metrics.md | Removes duplicated inline report-formatting guidance before the report template section. |
| .github/workflows/daily-cli-performance.md | Removes duplicated inline report-formatting guidance before summary report creation. |
| .github/workflows/copilot-session-insights.md | Removes duplicated inline guidelines from the “Create Analysis Discussion” phase. |
| .github/workflows/copilot-pr-prompt-analysis.md | Removes duplicated inline guidelines from the analysis discussion phase. |
| .github/workflows/copilot-pr-nlp-analysis.md | Removes duplicated inline guidelines from the analysis discussion phase. |
| .github/workflows/copilot-pr-merged-report.md | Removes duplicated inline guidelines from the merged-report generation section. |
| .github/workflows/copilot-cli-deep-research.md | Removes duplicated inline guidelines from the research prompt (keeps workflow-specific output format). |
| .github/workflows/commit-changes-analyzer.md | Removes duplicated inline guidelines before the developer report structure. |
| .github/workflows/cli-version-checker.md | Removes duplicated inline guidelines and updates the “structure pattern” reference to shared/reporting.md. |
| .github/workflows/ci-coach.md | Removes duplicated inline guidelines before the PR structure template. |
| .github/workflows/breaking-change-checker.md | Removes the in-file formatting-guidelines section from the reporting step. |
| .github/workflows/auto-triage-issues.md | Removes duplicated inline guidelines from the triage agent prompt. |
| .github/workflows/audit-workflows.md | Removes duplicated inline guidelines and embedded report template from the audit workflow prompt. |
| .github/workflows/agent-performance-analyzer.md | Removes duplicated inline guidelines from the performance analyzer prompt. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+171
to
172
| **Follow the Report Structure Pattern defined in `shared/reporting.md`.** | ||
|
|
There was a problem hiding this comment.
This update correctly points readers to shared/reporting.md, but there’s still a later instruction that says to “adapt to use Report Structure Pattern above”. Since the pattern is no longer inline, that phrasing becomes misleading—please update the later reference to point to shared/reporting.md as well.
Comment on lines
143
to
145
| --- | ||
|
|
||
| ## 📝 Report Formatting Guidelines | ||
|
|
||
| **CRITICAL**: Follow these formatting guidelines to create well-structured, readable reports: | ||
|
|
||
| ### 1. Header Levels | ||
| **Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy.** | ||
|
|
||
| The discussion title serves as h1, so all content headers should start at h3: | ||
| - Use `###` for main sections (e.g., "### Weekly Overview", "### Key Trends") | ||
| - Use `####` for subsections (e.g., "#### Issue Breakdown by Label") | ||
| - Never use `##` (h2) or `#` (h1) in the report body | ||
|
|
||
| ### 2. Progressive Disclosure | ||
| **Wrap long sections in `<details><summary><b>Section Name</b></summary>` tags to improve readability and reduce scrolling.** | ||
|
|
||
| Use collapsible sections for: | ||
| - Full issue lists with titles and descriptions | ||
| - Detailed breakdowns by label or type | ||
| - Historical comparisons or verbose data | ||
|
|
||
| Example: | ||
| ```markdown | ||
| <details> | ||
| <summary><b>Full Issue List</b></summary> | ||
|
|
||
| [Long list of issues...] | ||
|
|
||
| </details> | ||
| ``` | ||
|
|
||
| ### 3. Report Structure Pattern | ||
|
|
||
| Your report should follow this structure for optimal readability: | ||
|
|
||
| 1. **Weekly Overview** (always visible): 1-2 paragraph summary of the week's issue activity, highlighting key trends | ||
| 2. **Key Trends** (always visible): Notable patterns like increased activity, common issue types, or emerging topics | ||
| 3. **Summary Statistics** (always visible): Total counts, comparisons to previous week, breakdown by state/label | ||
| 4. **Detailed Issue Breakdown** (in `<details>` tags): Complete list of issues with titles, numbers, authors, and labels | ||
| 5. **Recommendations for Upcoming Week** (always visible): Actionable suggestions based on the analysis | ||
|
|
||
| ### Design Principles | ||
|
|
||
| Create reports that: | ||
| - **Build trust through clarity**: Most important info (overview, trends, key stats) immediately visible | ||
| - **Exceed expectations**: Add helpful context, week-over-week comparisons, trend analysis | ||
| - **Create delight**: Use progressive disclosure to reduce overwhelm for detailed data | ||
| - **Maintain consistency**: Follow the same patterns as other reporting workflows | ||
|
|
||
| --- |
There was a problem hiding this comment.
After removing the inline guidelines, this leaves two horizontal rules back-to-back (--- then another ---) with no content between. Consider deleting one of them to avoid redundant separators and keep the workflow prompt easier to scan.
Comment on lines
146
to
147
| --- | ||
|
|
There was a problem hiding this comment.
After removing the inline guidelines, this now renders as two consecutive horizontal rules (--- followed by another ---) with nothing between. Removing one of the separators would avoid redundant markdown noise.
Suggested change
| --- |
Comment on lines
157
to
158
| --- | ||
|
|
There was a problem hiding this comment.
Now that the inline guidelines are removed, this section has two horizontal rules back-to-back (--- / blank / ---). Consider keeping just one separator to reduce redundant markdown and improve readability.
Suggested change
| --- |
This was referenced Mar 1, 2026
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.
43 workflows contained inline copies of Report Formatting Guidelines (Header Levels, Progressive Disclosure, Report Structure Pattern, Design Principles) that duplicated
shared/reporting.md, creating a maintenance burden where guideline updates required changes in 43+ places.Changes
## 📝 Report Formatting Guidelinessections across 33 workflow filescopilot-pr-nlp-analysis.md,daily-testify-uber-super-expert.md) had only the standard guidelines removed — content following the "Maintain consistency" design principle bullet was kept in placeorg-health-report.md:### Phase 6: Create Discussion Reportwas nested inside the formatting guidelines section; extracted it back as a proper phase step after removing the guidelinescli-version-checker.mdandweekly-issue-summary.mdthat pointed to the now-removed "section above", redirecting toshared/reporting.mdAll 33 affected workflows already import
shared/reporting.mdvia runtime imports in their compiled lock files, so runtime behavior is unchanged.Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
https://api.github.com/graphql/usr/bin/gh /usr/bin/gh api graphql -f query=query($owner: String!, $name: String!) { repository(owner: $owner, name: $name) { hasDiscussionsEnabled } } -f owner=github -f name=gh-aw ithub/workflows/--norc rgo/bin/bash bash --no�� --noprofile sort bin/bash(http block)/usr/bin/gh /usr/bin/gh api graphql -f query=query($owner: String!, $name: String!) { repository(owner: $owner, name: $name) { hasDiscussionsEnabled } } -f owner=github -f name=gh-aw k/gh-aw/gh-aw/.g--norc p/bin/bash bash --no�� --noprofile grep ache/node/24.13.1/x64/bin/bash port Structure Ggrep ithub/workflows/-n ash bash(http block)/usr/bin/gh /usr/bin/gh api graphql -f query=query($owner: String!, $name: String!) { repository(owner: $owner, name: $name) { hasDiscussionsEnabled } } -f owner=github -f name=gh-aw ithub/workflows/--norc /home/REDACTED/wor--noprofile bash --no�� --noprofile bash sh port Structure Gbash ithub/workflows/--norc ache/uv/0.10.7/x--noprofile awk(http block)https://api.github.com/repos/astral-sh/setup-uv/git/ref/tags/eac588ad8def6316056a12d4907a9d4d84ff7a3b/usr/bin/gh gh api /repos/astral-sh/setup-uv/git/ref/tags/eac588ad8def6316056a12d4907a9d4d84ff7a3b --jq .object.sha /php.ini bash '~E_ALL' --noprofile all("session") a--norc cal/bin/bash /systemd-executor --no�� --noprofile bash n-dir/bash --noprofile(http block)https://api.github.com/repos/github/gh-aw/git/ref/tags/a70c5eada06553e3510ac27f2c3bda9d3705bccb/usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/a70c5eada06553e3510ac27f2c3bda9d3705bccb --jq .object.sha --noprofile bash 64/bin/bash --noprofile(http block)https://api.github.com/repos/githubnext/agentics/git/ref/tags//usr/bin/gh gh api /repos/githubnext/agentics/git/ref/tags/# --jq .object.sha --noprofile bash $name) { hasDiscussionsEnabled } } --noprofile(http block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.