-
Notifications
You must be signed in to change notification settings - Fork 306
Normalize report formatting guidelines across Phase 1 workflows #14311
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -233,6 +233,54 @@ For each generated chart: | |
|
|
||
| ### Phase 6: Create Analysis Discussion | ||
|
|
||
| ## π Report Formatting Guidelines | ||
|
|
||
| **CRITICAL**: Follow these formatting guidelines to create well-structured, readable reports: | ||
|
|
||
| ### 1. Header Levels | ||
| **Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy.** | ||
|
|
||
| The issue or discussion title serves as h1, so all content headers should start at h3: | ||
| - Use `###` for main sections (e.g., "### Executive Summary", "### Key Metrics") | ||
|
Comment on lines
+240
to
+244
|
||
| - Use `####` for subsections (e.g., "#### Detailed Analysis", "#### Recommendations") | ||
| - Never use `##` (h2) or `#` (h1) in the report body | ||
|
|
||
| ### 2. Progressive Disclosure | ||
| **Wrap long sections in `<details><summary><b>Section Name</b></summary>` tags to improve readability and reduce scrolling.** | ||
|
|
||
| Use collapsible sections for: | ||
| - Detailed analysis and verbose data | ||
| - Per-item breakdowns when there are many items | ||
| - Complete logs, traces, or raw data | ||
| - Secondary information and extra context | ||
|
|
||
| Example: | ||
| ```markdown | ||
| <details> | ||
| <summary><b>View Detailed Analysis</b></summary> | ||
|
|
||
| [Long detailed content here...] | ||
|
|
||
| </details> | ||
| ``` | ||
|
|
||
| ### 3. Report Structure Pattern | ||
|
|
||
| Your report should follow this structure for optimal readability: | ||
|
|
||
| 1. **Brief Summary** (always visible): 1-2 paragraph overview of key findings | ||
| 2. **Key Metrics/Highlights** (always visible): Critical information and important statistics | ||
| 3. **Detailed Analysis** (in `<details>` tags): In-depth breakdowns, verbose data, complete lists | ||
| 4. **Recommendations** (always visible): Actionable next steps and suggestions | ||
|
|
||
| ### Design Principles | ||
|
|
||
| Create reports that: | ||
| - **Build trust through clarity**: Most important info immediately visible | ||
| - **Exceed expectations**: Add helpful context, trends, comparisons | ||
| - **Create delight**: Use progressive disclosure to reduce overwhelm | ||
| - **Maintain consistency**: Follow the same patterns as other reporting workflows | ||
|
|
||
| Post a comprehensive discussion with the following structure: | ||
|
|
||
| **Title**: `Copilot PR Conversation NLP Analysis - [DATE]` | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -186,6 +186,54 @@ Based on the analysis, generate actionable insights: | |
|
|
||
| ### Phase 6: Create Analysis Discussion | ||
|
|
||
| ## π Report Formatting Guidelines | ||
|
|
||
| **CRITICAL**: Follow these formatting guidelines to create well-structured, readable reports: | ||
|
|
||
| ### 1. Header Levels | ||
| **Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy.** | ||
|
|
||
| The issue or discussion title serves as h1, so all content headers should start at h3: | ||
| - Use `###` for main sections (e.g., "### Executive Summary", "### Key Metrics") | ||
| - Use `####` for subsections (e.g., "#### Detailed Analysis", "#### Recommendations") | ||
|
Comment on lines
+194
to
+198
|
||
| - Never use `##` (h2) or `#` (h1) in the report body | ||
|
|
||
| ### 2. Progressive Disclosure | ||
| **Wrap long sections in `<details><summary><b>Section Name</b></summary>` tags to improve readability and reduce scrolling.** | ||
|
|
||
| Use collapsible sections for: | ||
| - Detailed analysis and verbose data | ||
| - Per-item breakdowns when there are many items | ||
| - Complete logs, traces, or raw data | ||
| - Secondary information and extra context | ||
|
|
||
| Example: | ||
| ```markdown | ||
| <details> | ||
| <summary><b>View Detailed Analysis</b></summary> | ||
|
|
||
| [Long detailed content here...] | ||
|
|
||
| </details> | ||
| ``` | ||
|
|
||
| ### 3. Report Structure Pattern | ||
|
|
||
| Your report should follow this structure for optimal readability: | ||
|
|
||
| 1. **Brief Summary** (always visible): 1-2 paragraph overview of key findings | ||
| 2. **Key Metrics/Highlights** (always visible): Critical information and important statistics | ||
| 3. **Detailed Analysis** (in `<details>` tags): In-depth breakdowns, verbose data, complete lists | ||
| 4. **Recommendations** (always visible): Actionable next steps and suggestions | ||
|
|
||
| ### Design Principles | ||
|
|
||
| Create reports that: | ||
| - **Build trust through clarity**: Most important info immediately visible | ||
| - **Exceed expectations**: Add helpful context, trends, comparisons | ||
| - **Create delight**: Use progressive disclosure to reduce overwhelm | ||
| - **Maintain consistency**: Follow the same patterns as other reporting workflows | ||
|
|
||
| Create a discussion with your findings using the safe-outputs create-discussion functionality. | ||
|
|
||
| **Discussion Title**: `Copilot PR Prompt Analysis - [DATE]` | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -123,6 +123,54 @@ Update cache memory with today's analysis following the cache management pattern | |
|
|
||
| ### Phase 5: Create Analysis Discussion | ||
|
|
||
| ## π Report Formatting Guidelines | ||
|
|
||
| **CRITICAL**: Follow these formatting guidelines to create well-structured, readable reports: | ||
|
|
||
| ### 1. Header Levels | ||
| **Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy.** | ||
|
|
||
| The issue or discussion title serves as h1, so all content headers should start at h3: | ||
| - Use `###` for main sections (e.g., "### Executive Summary", "### Key Metrics") | ||
| - Use `####` for subsections (e.g., "#### Detailed Analysis", "#### Recommendations") | ||
|
Comment on lines
+131
to
+135
|
||
| - Never use `##` (h2) or `#` (h1) in the report body | ||
|
|
||
| ### 2. Progressive Disclosure | ||
| **Wrap long sections in `<details><summary><b>Section Name</b></summary>` tags to improve readability and reduce scrolling.** | ||
|
|
||
| Use collapsible sections for: | ||
| - Detailed analysis and verbose data | ||
| - Per-item breakdowns when there are many items | ||
| - Complete logs, traces, or raw data | ||
| - Secondary information and extra context | ||
|
|
||
| Example: | ||
| ```markdown | ||
| <details> | ||
| <summary><b>View Detailed Analysis</b></summary> | ||
|
|
||
| [Long detailed content here...] | ||
|
|
||
| </details> | ||
| ``` | ||
|
|
||
| ### 3. Report Structure Pattern | ||
|
|
||
| Your report should follow this structure for optimal readability: | ||
|
|
||
| 1. **Brief Summary** (always visible): 1-2 paragraph overview of key findings | ||
| 2. **Key Metrics/Highlights** (always visible): Critical information and important statistics | ||
| 3. **Detailed Analysis** (in `<details>` tags): In-depth breakdowns, verbose data, complete lists | ||
| 4. **Recommendations** (always visible): Actionable next steps and suggestions | ||
|
|
||
| ### Design Principles | ||
|
|
||
| Create reports that: | ||
| - **Build trust through clarity**: Most important info immediately visible | ||
| - **Exceed expectations**: Add helpful context, trends, comparisons | ||
| - **Create delight**: Use progressive disclosure to reduce overwhelm | ||
| - **Maintain consistency**: Follow the same patterns as other reporting workflows | ||
|
|
||
| Generate a human-readable Markdown report and create a discussion. | ||
|
|
||
| **Discussion Title Format**: | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The inserted guidelines forbid
#/##headings in the report body, but the report template below still uses# π€ ...and multiple##sections (Summary, Merged Pull Requests, etc.). This is inconsistent with both the new guidance and shared/reporting.md; update the template to use###/####headings only and rely on the issue/discussion title for h1.