Skip to content

Add markdown formatting guidelines to daily-file-diet workflow#11659

Merged
pelikhan merged 3 commits intomainfrom
copilot/update-report-formatting-guidelines-again
Jan 24, 2026
Merged

Add markdown formatting guidelines to daily-file-diet workflow#11659
pelikhan merged 3 commits intomainfrom
copilot/update-report-formatting-guidelines-again

Conversation

Copy link
Contributor

Copilot AI commented Jan 24, 2026

The daily-file-diet workflow generates issues for large files but lacks formatting guidelines, resulting in inconsistent issue structure compared to other reporting workflows like daily-code-metrics and daily-compiler-quality.

Changes

  • Added formatting guidelines section instructing the AI agent to:

    • Use h3 (###) or lower for headers (issue title is h1)
    • Wrap detailed analysis in <details><summary><b>Section Name</b></summary> tags
    • Keep summary and key metrics visible, collapse lengthy details
  • Updated issue template structure:

    • Changed all headers from h2 to h3
    • Wrapped "Full File Analysis" in collapsible details
    • Wrapped "Test Coverage Plan" in collapsible details
    • Wrapped "Additional Context" in collapsible details
    • Kept Overview, Current State, Refactoring Strategy, and Acceptance Criteria always visible

Example

### Overview
The file `pkg/workflow/compiler.go` has grown to 850 lines...

### Current State
- **File**: `pkg/workflow/compiler.go`
- **Size**: 850 lines
- **Test Coverage**: 0.65 (65% coverage)

<details>
<summary><b>Full File Analysis</b></summary>

#### Detailed Breakdown
[Lengthy semantic analysis, function counts, complexity hotspots...]

</details>

### Refactoring Strategy
[Always visible actionable recommendations...]

This aligns with patterns established in daily-code-metrics (line 239) and daily-compiler-quality, applying progressive disclosure principles to reduce cognitive load while maintaining information accessibility.

Original prompt

This section details on the original issue you should resolve

<issue_title>[workflow-style] Normalize report formatting for daily-file-diet</issue_title>
<issue_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:

  1. Build trust through clarity: Most important info immediately visible
  2. Exceed expectations: Add helpful context and actionable suggestions
  3. Create delight: Use progressive disclosure to reduce overwhelm
  4. 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

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits January 24, 2026 13:11
…matting guidelines

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Update workflow to normalize report formatting for daily-file-diet Add markdown formatting guidelines to daily-file-diet workflow Jan 24, 2026
Copilot AI requested a review from pelikhan January 24, 2026 13:18
@pelikhan pelikhan marked this pull request as ready for review January 24, 2026 13:20
@pelikhan pelikhan merged commit f97a587 into main Jan 24, 2026
@pelikhan pelikhan deleted the copilot/update-report-formatting-guidelines-again branch January 24, 2026 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[workflow-style] Normalize report formatting for daily-file-diet

2 participants