Skip to content

[workflow-style] Normalize report formatting guidance across reporting workflows #27481

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 3 commits into from
Apr 21, 2026
+13 −3
Merged

[workflow-style] Normalize report formatting guidance across reporting workflows #27481

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6296b30
Initial plan
Copilot Apr 21, 2026
7bfaa76
Normalize report formatting guidance across reporting workflows
Copilot Apr 21, 2026
e6bfce9
Remove unintended generated documentation updates
Copilot Apr 21, 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
2 changes: 2 additions & 0 deletions .github/workflows/daily-safe-output-optimizer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,8 @@ After updating the tool description:
- **Be evidence-based**: Show actual error examples, not assumptions
- **Be actionable**: Recommend specific description improvements
- **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 +370 to +371
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

The <details><summary>Section Name</summary> snippet is incomplete without a closing </details> (and usually a blank line after </summary>). To avoid agents producing broken disclosure blocks, update this rule to show/require the full <details>…</details> structure.

Suggested change
- **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.
- **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in full disclosure blocks like `<details><summary>Section Name</summary>`
`Section content`
`</details>`
to improve readability and reduce scrolling.

Copilot uses AI. Check for mistakes.
### Issue Creation Rules
- **Skip if no tool description issues found**: Don't create issue for workflow prompt issues only
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/design-decision-gate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,10 @@ All ADRs are stored in `docs/adr/` as Markdown files numbered by PR number (e.g.
> 🔒 *This PR cannot merge until an ADR is linked in the PR body.*
```

### Report Formatting

- **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 21, 2026

Choose a reason for hiding this comment

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

The report-formatting rule references <details><summary>Section Name</summary> but doesn’t indicate closing </details>. Since <details> blocks must be closed to render correctly, it would be clearer to show the full wrapper (or explicitly call out the closing tag requirement).

Suggested change
- **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.
- **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in a complete `<details>` block such as `<details><summary>Section Name</summary>...</details>` to improve readability and reduce scrolling.

Copilot uses AI. Check for mistakes.

## Step 4b: If ADR Found — Verify Implementation Matches

If an ADR **is** found (either in the PR body, on the PR branch, or in a linked issue), verify that the implementation aligns with the stated decision.
Expand Down
7 changes: 4 additions & 3 deletions .github/workflows/spec-librarian.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,9 +328,10 @@ The following specifications are outdated:
1. **Be thorough**: Check ALL packages, not just a sample
2. **Be precise**: Reference exact file paths, function names, and dates
3. **Be actionable**: Every finding should have a clear recommendation
4. **Use progressive disclosure**: Wrap details in `<details>` tags
5. **One issue per run**: The `max: 1` limit ensures no issue spam
6. **Skip if open**: The `skip-if-match` rule prevents duplicate issues
4. **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 21, 2026

Choose a reason for hiding this comment

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

This rule suggests wrapping long sections in <details><summary>Section Name</summary> but omits the closing </details> (and typical blank line after </summary>). Consider updating the guidance to show the complete <details>…</details> pattern so generated reports aren’t malformed.

Suggested change
4. **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.
4. **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in the complete `<details><summary>Section Name</summary>\n\nContent\n</details>` pattern to improve readability and reduce scrolling.

Copilot uses AI. Check for mistakes.
5. **Use progressive disclosure**: Wrap details in `<details>` tags
6. **One issue per run**: The `max: 1` limit ensures no issue spam
7. **Skip if open**: The `skip-if-match` rule prevents duplicate issues

## Success Criteria

Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/test-quality-sentinel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -451,6 +451,9 @@ After posting the comment, submit a pull request review based on the verdict:

## Guidelines

### Report Formatting
- **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 +455 to +456
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

The guidance shows <details><summary>Section Name</summary> but omits the required closing </details> (and typically a blank line after </summary>). As written, it can lead to malformed HTML/Markdown in generated reports; consider updating the example to include the full <details>…</details> wrapper (or explicitly mention closing tags).

Suggested change
- **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.
- **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in a full `<details>…</details>` block, for example: `<details><summary>Section Name</summary>
Section content
</details>`, to improve readability and reduce scrolling.

Copilot uses AI. Check for mistakes.
### Analysis Scope
- **Focus only on new and changed tests** — do not analyze unchanged test files
- **Support Go (`*_test.go`) and JavaScript (`*.test.cjs`, `*.test.js`)** as primary targets; note other languages but don't score them
Expand Down
Loading