Skip to content

Normalize report-style output guidance in non-compliant workflows#34512

Merged
pelikhan merged 2 commits into
mainfrom
copilot/normalize-report-formatting
May 24, 2026
Merged

Normalize report-style output guidance in non-compliant workflows#34512
pelikhan merged 2 commits into
mainfrom
copilot/normalize-report-formatting

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 24, 2026

This updates two workflow prompts that generate reports/issues but were inconsistent with the repo’s report formatting conventions. The changes align header hierarchy and progressive-disclosure guidance so generated content is easier to scan.

  • What changed

    • .github/workflows/github-mcp-tools-report.md

      • Added explicit formatting instructions to the prompt:
        • use ### or lower for report headers
        • wrap long sections in <details><summary>…</summary> blocks
        • keep summary/highlights/recommendations visible, with deep analysis collapsed
      • Normalized the Phase 4 embedded report template header levels:
        • ####
        • ######
        • nested section headers adjusted consistently (##### where needed)
    • .github/workflows/ab-testing-advisor.md

      • Added progressive disclosure guidance in output constraints:
        • wrap long analysis sections in <details><summary>View Details</summary> for scannability
  • Example template pattern now required

### Report Title

- Key summary point
- Key metric/highlight

<details>
<summary>Full Analysis Details</summary>

#### Detailed Section
Long-form analysis, tables, and supporting context.

</details>

Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Copilot AI changed the title [WIP] Update report formatting for non-compliant workflows Normalize report-style output guidance in non-compliant workflows May 24, 2026
Copilot AI requested a review from gh-aw-bot May 24, 2026 18:45
@pelikhan pelikhan marked this pull request as ready for review May 24, 2026 19:05
Copilot AI review requested due to automatic review settings May 24, 2026 19:05
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR standardizes report/issue formatting guidance across two workflow prompt files so generated content follows the repo’s “h3-and-below” header hierarchy and uses progressive disclosure (<details><summary>…</summary>) for long analysis.

Changes:

  • Added explicit output formatting constraints to .github/workflows/github-mcp-tools-report.md (h3-or-lower headers + <details> progressive disclosure guidance).
  • Normalized the embedded Phase 4 report template headings in .github/workflows/github-mcp-tools-report.md from #/## to ###/####/#####.
  • Added <details> progressive-disclosure guidance to .github/workflows/ab-testing-advisor.md output constraints for scannable issue bodies.
Show a summary per file
File Description
.github/workflows/github-mcp-tools-report.md Adds/report-format constraints and downgrades template headings to match repo conventions (h3+).
.github/workflows/ab-testing-advisor.md Adds a <details> guideline so long analysis is collapsible in generated issue bodies.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 2/2 changed files
  • Comments generated: 0

@github-actions
Copy link
Copy Markdown
Contributor

@copilot please keep workflow output guidance at h3-or-lower and use

Details for long analysis in the next pass.

Generated by 👨‍🍳 PR Sous Chef · gpt54 5M ·

@pelikhan pelikhan merged commit 35265dc into main May 24, 2026
4 checks passed
@pelikhan pelikhan deleted the copilot/normalize-report-formatting branch May 24, 2026 19:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[workflow-style] Normalize report formatting for non-compliant workflows

4 participants