Skip to content

Add report formatting guidelines to daily-compiler-quality workflow#11678

Merged
pelikhan merged 2 commits intomainfrom
copilot/normalize-report-formatting
Jan 24, 2026
Merged

Add report formatting guidelines to daily-compiler-quality workflow#11678
pelikhan merged 2 commits intomainfrom
copilot/normalize-report-formatting

Conversation

Copy link
Contributor

Copilot AI commented Jan 24, 2026

The daily-compiler-quality workflow generates reports without standardized formatting, making them inconsistent with other reporting workflows (daily-code-metrics, daily-issues-report, audit-workflows).

Changes

  • Added formatting guidelines section to Phase 5 with:

    • Header level standards (h3 or lower for proper hierarchy)
    • Progressive disclosure pattern using <details><summary> tags
    • Suggested report structure (summary/recommendations visible, analysis/trends collapsed)
    • Design principles (clarity, context, reduced overwhelm, consistency)
  • Updated discussion template to follow guidelines:

    • Changed main headers from h1/h2 to h3
    • Wrapped detailed file analysis, historical trends, and cache summary in collapsible sections
    • Maintained key information (executive summary, quality scores, recommendations) immediately visible

Example

### Executive Summary
[2-3 paragraph summary - always visible]

### Files Analyzed Today

<details>
<summary><b>📁 Detailed File Analysis</b></summary>

#### 1. `compiler_orchestrator.go` - Score: 82/100 ✅
[Detailed analysis with scores, strengths, issues, recommendations]

</details>

Recompiled workflow to .lock.yml with embedded formatting guidelines.

Original prompt

This section details on the original issue you should resolve

<issue_title>[workflow-style] Normalize report formatting for daily-compiler-quality</issue_title>
<issue_description>### Workflow to Update

Workflow File: .github/workflows/daily-compiler-quality.md
Issue: This workflow analyzes compiler quality and creates reports but doesn't include markdown style guidelines

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 report to maintain proper document hierarchy."

2. Progressive Disclosure

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

Example:

<details>
<summary><b>Detailed Analysis Results</b></summary>

[Long detailed content here...]

</details>

3. Report Structure

Suggest a structure like:

  • Brief summary of quality score (always visible)
  • Key quality issues (always visible)
  • Detailed file analysis (in <details> tags)
  • Historical trends (in <details> tags)
  • Recommendations (always visible)

Design Principles (Airbnb-Inspired)

The updated workflow should create reports that:

  1. Build trust through clarity: Most important info immediately visible
  2. Exceed expectations: Add helpful context, trends, comparisons
  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, daily-issues-report, or audit-workflows for good examples of structured reporting with progressive disclosure.

Agent Task

Update the workflow file .github/workflows/daily-compiler-quality.md to include the formatting guidelines above in the prompt instructions. Test the updated workflow to ensure it produces well-formatted reports.
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)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Update daily-compiler-quality workflow for report formatting Add report formatting guidelines to daily-compiler-quality workflow Jan 24, 2026
Copilot AI requested a review from pelikhan January 24, 2026 16:06
@pelikhan pelikhan marked this pull request as ready for review January 24, 2026 16:19
@pelikhan pelikhan merged commit 0c77d05 into main Jan 24, 2026
118 checks passed
@pelikhan pelikhan deleted the copilot/normalize-report-formatting branch January 24, 2026 16:19
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-compiler-quality

2 participants