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

[github-actions]

Overview

During the daily workflow style normalization review, I identified 3 reporting workflows that ran in the last 24 hours but lack markdown formatting guidelines in their prompts. These workflows generate structured reports but don't include instructions for proper header levels or progressive disclosure patterns.

Non-Compliant Workflows

The following workflows create reports (issues, PR comments, or discussions) but need formatting guidelines added:

Workflow File	Report Type	Issues Found
.github/workflows/issue-monster.md	Issue assignment (via github-script step output)	No formatting guidelines in prompt
.github/workflows/pr-sous-chef.md	PR comments	No formatting guidelines in prompt
.github/workflows/smoke-ci.md	Issues and PR comments	No formatting guidelines in prompt

Required Changes

For each workflow listed above, update the prompt section to include markdown formatting guidelines. Add a new "## Formatting Requirements" or "## Report Formatting" section before the completion requirements.

1. Header Levels

Add this instruction:

### Formatting Requirements

- Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy.
- Never use h1 (#) or h2 (##) headers - these are reserved for titles.

2. Progressive Disclosure

Add this instruction:

- Wrap long sections or verbose details in `<details><summary>Section Name</summary>` tags to improve readability and reduce scrolling.
- Keep critical information visible (summary, key metrics, recommendations).
- Use collapsible sections for secondary details (full logs, per-item breakdowns, supporting data).

3. Report Structure Pattern

Suggest this pattern:

### Recommended Report Structure

1. **Overview**: 1-2 paragraphs summarizing key findings (always visible)
2. **Critical Information**: Key metrics, status, critical issues (always visible)
3. **Details**: Use `<details><summary>Section Name</summary>` for expanded content
4. **Recommendations**: Actionable next steps (always visible)

Example Addition

Here's an example section to add to workflow prompts:

## Formatting Requirements

- **Header Levels**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy.
- **Progressive Disclosure**: Wrap long sections in `<details><summary>Section Name</summary>` tags to improve readability and reduce scrolling.
- **Report Structure**:
  1. Brief summary (always visible)
  2. Key metrics or highlights (always visible)
  3. Detailed analysis (in `<details>` tags)
  4. Recommendations (always visible)

Example:
\`\`\`markdown
### Summary
- Key finding 1
- Key finding 2

<details>
<summary>View Detailed Results</summary>

[Comprehensive details, logs, traces]

</details>

### Recommendations
[Actionable next steps]
\`\`\`

Design Principles

The updated workflows should create reports that:

1. Build trust through clarity: Most important information immediately visible
2. Exceed expectations: Add helpful context, trends, comparisons
3. Create delight: Use progressive disclosure to reduce overwhelm
4. Maintain consistency: Follow the same patterns as other reporting workflows

Reference Examples

See these workflows for good formatting guidance:

• .github/workflows/daily-token-consumption-report.md (lines 175-183)
• .github/workflows/copilot-token-audit.md (lines 220-227)
• .github/workflows/api-consumption-report.md (line 520)

Workflow Analysis Summary

• Period: Last 24 hours
• Total active workflows: 27
• Workflows mapped to files: 11
• Workflows creating reports: 3
• Non-compliant workflows: 3
• Compliance rate: 0% (among reporting workflows that ran)

All Active Workflows (Last 24h)

• AI Moderator
• Agent Performance Analyzer - Meta-Orchestrator
• Auto-Triage Issues
• Chaos PR Bundle Fuzzer
• Claude Code User Documentation Review
• Constraint Solving — Problem of the Day
• Copilot PR Conversation NLP Analysis
• Daily A/B Testing Advisor
• Daily Choice Type Test
• Daily Copilot Token Usage Audit
• Daily Documentation Updater
• Daily Go Function Namer
• Daily Token Consumption Report (Sentry OTel)
• Draft PR Cleanup
• GitHub API Consumption Report Agent
• GitHub MCP Structural Analysis
• Glossary Maintainer
• Issue Monster ⚠️ (needs formatting guidelines)
• PR Description Updater
• PR Sous Chef ⚠️ (needs formatting guidelines)
• PR Triage Agent
• Package Specification Enforcer
• Repository Quality Improvement Agent
• Smoke CI ⚠️ (needs formatting guidelines)
• Typist - Go Type Analysis
• Workflow Normalizer
• [aw] Failure Investigator (6h)

Next Steps

1. Update each workflow file listed in the table above to include formatting guidelines
2. Test the updated workflows on their next run
3. Monitor generated reports for compliance with the new formatting standards
4. Consider adding these guidelines to a shared import file (e.g., shared/report-formatting.md) to reduce duplication

Generated by 🔧 Workflow Normalizer · ● 11.1M · ◷

• expires on May 20, 2026, 1:54 PM UTC

[github-actions]

🍪 Issue Monster selected this for Copilot

I've identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

Om nom nom! 🍪

🍪 Om nom nom by Issue Monster · ● 75.8K · ◷