Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 25, 2026

The weekly-issue-summary workflow generates reports without formatting guidance, resulting in inconsistent structure compared to other reporting workflows.

Changes

  • Header hierarchy: Use h3 (###) or lower for all report sections (discussion title is h1)
  • Progressive disclosure: Wrap verbose sections (full issue lists, detailed breakdowns) in <details><summary> tags
  • Report structure: 5-section template ensuring critical info (overview, trends, stats, recommendations) stays visible while details are collapsible
  • Design principles: Align with patterns from audit-workflows.md, daily-firewall-report.md, and shared/reporting.md

Example structure:

### Weekly Overview
[Always visible summary...]

### Summary Statistics
[Key metrics...]

<details>
<summary><b>Detailed Issue Breakdown</b></summary>

[Long list of issues...]

</details>

### Recommendations for Upcoming Week
[Actionable suggestions...]

The compiled .lock.yml embeds these guidelines in the agent prompt, ensuring consistent report formatting.

Original prompt

This section details on the original issue you should resolve

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

Workflow File: .github/workflows/weekly-issue-summary.md
Issue: This workflow generates weekly issue 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 Issue List</b></summary>

[Long list of issues...]

</details>

3. Report Structure

Suggest a structure like:

  • Weekly overview and key trends (always visible)
  • Summary statistics (always visible)
  • Detailed issue breakdowns (in <details> tags)
  • Recommendations for upcoming week (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/weekly-issue-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)


💡 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.

- Add header level guidelines (use h3/### or lower)
- Add progressive disclosure instructions with examples
- Add report structure template with collapsible sections
- Align with design principles from other reporting workflows

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

2 participants