[workflow-style] Normalize report formatting for breaking-change-checker

[github-actions]

Workflow to Update

Workflow File: .github/workflows/breaking-change-checker.md
Issue: This workflow generates daily reports but doesn't include markdown style guidelines for consistent, user-friendly formatting.

Required Changes

Update the workflow prompt to include these formatting guidelines:

1. Header Levels

Add instruction: "Use h3 (###) or lower for all headers in your issue report to maintain proper document hierarchy."

Example:

### Breaking Changes Detected
#### API Changes

2. Progressive Disclosure

Add instruction: "Wrap detailed analysis in <details><summary><b>Section Name</b></summary> tags to improve readability and reduce scrolling."

Example:

<details>
<summary><b>Full Code Diff Analysis</b></summary>

[Detailed diff and analysis here...]

</details>

3. Report Structure

Suggest a structure like:

• Summary (always visible): Count of breaking changes, severity assessment
• Critical Breaking Changes (always visible): List of changes requiring immediate attention
• Detailed Analysis (in <details> tags): Full diff analysis, code examples
• Recommendations (always visible): Migration steps, version bump guidance

Design Principles (Airbnb-Inspired)

The updated workflow should create reports that:

1. Build trust through clarity: Most important breaking changes immediately visible
2. Exceed expectations: Add helpful context like impact assessment, migration examples
3. Create delight: Use progressive disclosure to reduce overwhelm from long diffs
4. Maintain consistency: Follow the same patterns as other reporting workflows

Example Reference

See workflows like daily-repo-chronicle or audit-workflows that import shared/reporting.md for good examples of structured reporting.

Agent Task

1. Update .github/workflows/breaking-change-checker.md to include an import: - shared/reporting.md in the frontmatter imports section
2. Reference the style guidelines in the workflow instructions
3. Test the updated workflow to ensure it produces well-formatted reports

AI generated by Workflow Normalizer

• expires on Feb 11, 2026, 3:23 AM UTC