-
Notifications
You must be signed in to change notification settings - Fork 225
Description
Workflow Style Normalization Report - 2026-02-14
Period: Last 24 hours
Workflows Reviewed: 12 active workflows
Issues Found: 3 workflows need formatting guideline imports
Issues Created: 3
Compliance Status
- ✅ Compliant: 9 workflows follow style guidelines (75%)
⚠️ Needs Improvement: 3 workflows need updates (25%)
Executive Summary
The workflow normalization review found that most active workflows are already following markdown formatting guidelines. A significant number (32+ workflows) already import shared/reporting.md, which provides comprehensive formatting standards based on Airbnb's design principles.
Three workflows that generate user-facing content (issues and comments) were identified as missing the shared reporting guidelines import. These workflows would benefit from consistent formatting to improve readability and user experience.
View Active Workflows Reviewed
Workflows Analyzed (Last 24 Hours)
- ✅ AI Moderator - No reports generated (labels only)
- ❌ CI Failure Doctor - Creates diagnostic issues (needs improvement)
- ✅ Changeset Generator - No reports (code generation only)
- ✅ Daily Syntax Error Quality Check - Has comprehensive inline guidelines
- ✅ Daily Team Evolution Insights - Has comprehensive inline guidelines
- ✅ PR Nitpick Reviewer - Imports reporting.md
- ❌ Smoke Temporary ID - Creates test issues (needs improvement)
- ❌ Smoke Project - Adds test comments (needs improvement)
- ✅ Smoke Codex - Imports reporting.md
- ✅ Auto-Assign Issue - No reports (assignment only)
- ✅ Cloclo - No reports (PR creation only)
- ✅ Agent Container Smoke Test - Smoke test (no reports)
View Non-Compliant Workflows Details
Workflows Needing Updates
1. ci-doctor.md
- Issue: Creates diagnostic reports for CI failures without formatting guidelines
- Safe Outputs:
create-issue,add-comment,update-issue - Impact: Diagnostic reports would be more readable with progressive disclosure
- Solution: Import
shared/reporting.md - Issue Created: [workflow-style] Normalize report formatting for ci-doctor #15586
2. smoke-temporary-id.md
- Issue: Creates test issues without formatting guidelines
- Safe Outputs:
create-issue - Impact: Test reports would benefit from consistent structure
- Solution: Import
shared/reporting.md - Issue Created: [workflow-style] Normalize report formatting for smoke-temporary-id #15588
3. smoke-project.md
- Issue: Adds test comments without formatting guidelines
- Safe Outputs:
add-comment - Impact: Test results would be easier to scan with collapsible sections
- Solution: Import
shared/reporting.md - Issue Created: [workflow-style] Normalize report formatting for smoke-project #15589
Key Findings
✅ Strengths
- Shared Guidelines Exist: The
shared/reporting.mdfile provides comprehensive formatting standards - Wide Adoption: 32+ workflows already import reporting.md or have inline guidelines
- Consistent Patterns: Most reporting workflows follow similar structure (summary, details, recommendations)
- Design Principles: Guidelines based on Airbnb's design principles (trust, clarity, delight, consistency)
📊 Statistics
- Workflows with guidelines: 75% (9/12 active workflows)
- Workflows using shared import: 66% (21+ out of 32+ reporting workflows)
- Workflows with inline guidelines: Several high-priority workflows have custom guidelines
Issues Created
Three issues have been created to address the non-compliant workflows:
- [workflow-style] Normalize report formatting for ci-doctor #15586 - [workflow-style] Normalize report formatting for ci-doctor
- [workflow-style] Normalize report formatting for smoke-temporary-id #15588 - [workflow-style] Normalize report formatting for smoke-temporary-id
- [workflow-style] Normalize report formatting for smoke-project #15589 - [workflow-style] Normalize report formatting for smoke-project
Each issue includes:
- Specific file to update
- Exact change needed (adding import)
- Explanation of benefits
- References to example workflows
Recommendations
High Priority ✅
- Update the 3 identified workflows to import
shared/reporting.md- Simple change: Add one line to imports section
- Immediate benefit: Consistent formatting across all reports
- Low risk: No breaking changes to existing functionality
Medium Priority 📋
- Monitor future workflows to ensure new reporting workflows import guidelines
- Add to workflow review checklist
- Include in workflow template/documentation
Low Priority 🔄
- Consider extracting common patterns from workflows with custom inline guidelines
- Some workflows have very detailed custom guidelines
- Could benefit from specialized shared imports (e.g.,
shared/testing-reports.md)
Success Metrics
After implementing the recommended changes:
- All active reporting workflows import formatting guidelines
- Compliance rate increases from 75% to 100%
- User feedback on report readability improves
- Consistency across workflow reports is maintained
Next Steps
- Review and merge the 3 improvement issues
- Test updated workflows to ensure formatting is applied
- Document the import requirement for new workflows
- Schedule next review in 2 weeks to verify improvements
This normalization effort ensures all agentic workflows provide a consistent, delightful user experience through well-structured, readable reports. The shared reporting.md file makes it easy to maintain this consistency across 100+ workflows.
Generated by Workflow Normalizer
- expires on Feb 15, 2026, 3:23 AM UTC