-
Notifications
You must be signed in to change notification settings - Fork 225
Description
Workflow to Update
Workflow File: .github/workflows/smoke-project.md
Issue: This workflow adds comments with test results but doesn't include markdown style guidelines
Required Changes
Update the workflow to import the shared reporting guidelines:
imports:
- shared/mood.md
+ - shared/reporting.mdThis will automatically provide the workflow with:
1. Header Levels
Instruction to use h3 (###) or lower for all headers in reports to maintain proper document hierarchy.
2. Progressive Disclosure
Instruction to wrap long sections in <details><summary><b>Section Name</b></summary> tags to improve readability and reduce scrolling.
Example:
<details>
<summary><b>View Full Test Output</b></summary>
[Long detailed content here...]
</details>3. Report Structure
Suggested structure:
- Brief summary (always visible)
- Key test results or highlights (always visible)
- Detailed logs and output (in
<details>tags) - Recommendations (always visible)
Design Principles (Airbnb-Inspired)
The updated workflow should create comments that:
- Build trust through clarity: Most important info immediately visible
- Exceed expectations: Add helpful context, trends, comparisons
- Create delight: Use progressive disclosure to reduce overwhelm
- Maintain consistency: Follow the same patterns as other reporting workflows
Example Reference
See workflows like daily-team-evolution-insights or audit-workflows for good examples of structured reporting. The shared reporting.md file provides these guidelines automatically.
Agent Task
Update the workflow file .github/workflows/smoke-project.md by adding - shared/reporting.md to the imports section. This will make the formatting guidelines available to the AI agent when it generates test comments.
Generated by Workflow Normalizer
- expires on Feb 15, 2026, 3:23 AM UTC