Skip to content

Normalize report formatting guidelines across daily workflow prompts#28649

Merged
pelikhan merged 2 commits intomainfrom
copilot/workflow-style-normalize-report-formatting
Apr 27, 2026
Merged

Normalize report formatting guidelines across daily workflow prompts#28649
pelikhan merged 2 commits intomainfrom
copilot/workflow-style-normalize-report-formatting

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 27, 2026

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 ## Guidelines section (header levels + progressive disclosure)
  • daily-regulatory.md — Inserted formatting guideline into ### Discussion Format section (header levels)
  • daily-safe-output-integrator.md — Added formatting guideline to ## Phase 7 PR creation section (header levels + progressive disclosure)

Guideline added (matches daily-performance-summary.md pattern)

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

…, 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>
Copilot AI changed the title [WIP] Normalize report formatting for non-compliant workflows Normalize report formatting guidelines across daily workflow prompts Apr 27, 2026
Copilot AI requested a review from gh-aw-bot April 27, 2026 01:11
@github-actions
Copy link
Copy Markdown
Contributor

Hey @Copilot 👋 — thanks for this consistency fix across the daily workflow prompts! Normalizing the report formatting guideline across audit-workflows.md, daily-regulatory.md, and daily-safe-output-integrator.md is a clean, focused change.

This repository doesn't have a CONTRIBUTING.md, so no formal guidelines could be checked — the PR looks well-described and tightly scoped. It's currently in draft state; once you're ready, marking it as ready for review should be all that's needed to move it forward.

Generated by Contribution Check · ● 1.4M ·

@github-actions github-actions Bot mentioned this pull request Apr 27, 2026
@pelikhan pelikhan marked this pull request as ready for review April 27, 2026 13:36
Copilot AI review requested due to automatic review settings April 27, 2026 13:36
@pelikhan pelikhan merged commit 228da33 into main Apr 27, 2026
20 checks passed
@pelikhan pelikhan deleted the copilot/workflow-style-normalize-report-formatting branch April 27, 2026 13:36
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

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.md under ## Guidelines.
  • Inserted the same guideline into daily-regulatory.md under ### Discussion Format.
  • Added the guideline to daily-safe-output-integrator.md in 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

Comment on lines 89 to +92
**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.
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.

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