-
Notifications
You must be signed in to change notification settings - Fork 47
Description
Workflow to Update
Workflow File: .github/workflows/daily-file-diet.md
Issue: This workflow creates issues for large files but doesn't include markdown style guidelines for the generated issue content
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."
2. Progressive Disclosure
Add instruction: "Wrap detailed file analysis and code snippets in <details><summary><b>Section Name</b></summary> tags to improve readability."
Example:
<details>
<summary><b>Full File Analysis</b></summary>
[Long detailed content here...]
</details>3. Issue Structure
Suggest a structure like:
- Brief summary of the file size issue (always visible)
- Key metrics (LOC, complexity, test coverage) (always visible)
- Detailed file structure analysis (in
<details>tags) - Refactoring suggestions (always visible)
Design Principles (Airbnb-Inspired)
The updated workflow should create issues that:
- Build trust through clarity: Most important info immediately visible
- Exceed expectations: Add helpful context and actionable suggestions
- Create delight: Use progressive disclosure to reduce overwhelm
- Maintain consistency: Follow the same patterns as other reporting workflows
Example Reference
See workflows like daily-code-metrics or daily-compiler-quality for good examples of structured reporting with progressive disclosure.
Agent Task
Update the workflow file .github/workflows/daily-file-diet.md to include the formatting guidelines above in the prompt instructions. Test the updated workflow to ensure it produces well-formatted issues.
Related to #11271
AI generated by Workflow Normalizer
- expires on Jan 31, 2026, 12:23 PM UTC