Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 25, 2026

The daily-performance-summary workflow lacked explicit formatting guidelines, leading to potentially inconsistent or difficult-to-read reports. Added structured formatting instructions to align with other reporting workflows (audit-workflows, daily-firewall-report).

Changes

  • Added formatting guidelines section (Phase 5.5) with:

    • Header hierarchy: h3 (###) or lower only (discussion title = h1)
    • Progressive disclosure: <details> tags for verbose sections
    • 5-part report structure: overview → highlights → critical issues → detailed data (collapsed) → recommendations
  • Updated discussion template to follow the structure:

    ### Performance Overview
    [2-3 paragraph executive summary]
    
    ### Key Highlights
    -**[NUMBER]** PRs merged in the last 90 days
    - 📊 **[NUMBER]** issues resolved
    
    ### 🚨 Critical Performance Issues
    [Immediate attention items or "None detected"]
    
    <details>
    <summary><b>📊 Detailed Benchmark Results</b></summary>
    [Comprehensive metrics tables, charts analysis]
    </details>
    
    ### 💡 Optimization Recommendations
    [Actionable insights]

Design rationale

Follows Airbnb-inspired principles: build trust through clarity (critical info visible), exceed expectations (context + trends), create delight (reduce overwhelm), maintain consistency (match existing reporting workflows).

Original prompt

This section details on the original issue you should resolve

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

Workflow File: .github/workflows/daily-performance-summary.md
Issue: This workflow generates daily performance summaries but doesn't include markdown style guidelines for progressive disclosure

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 long sections in <details><summary><b>Section Name</b></summary> tags to improve readability and reduce scrolling."

Example:

<details>
<summary><b>Full Performance Metrics</b></summary>

[Long performance data...]

</details>

3. Report Structure

Suggest a structure like:

  • Performance overview and key highlights (always visible)
  • Critical performance issues (always visible)
  • Detailed benchmark results (in <details> tags)
  • Optimization 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 audit-workflows or daily-firewall-report for good examples of structured reporting with progressive disclosure.

Agent Task

Update the workflow file .github/workflows/daily-performance-summary.md to include the formatting guidelines above in the prompt instructions. Test the updated workflow to ensure it produces well-formatted reports.

AI generated by Workflow Normalizer

  • expires on Feb 1, 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 25, 2026 13:15
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
…iling spaces

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Update daily performance summary report formatting Add progressive disclosure formatting guidelines to daily-performance-summary workflow Jan 25, 2026
Copilot AI requested a review from pelikhan January 25, 2026 13:24
@pelikhan pelikhan marked this pull request as ready for review January 25, 2026 15:34
@pelikhan pelikhan merged commit 83de0cb into main Jan 25, 2026
@pelikhan pelikhan deleted the copilot/update-daily-performance-report-formatting branch January 25, 2026 15:35
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-performance-summary

2 participants