From 7c70bd192297313c7568282bf0d9b192ea72e880 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 23 Jan 2026 17:01:25 +0000 Subject: [PATCH 1/2] Initial plan From 5363eae99cc9e4102dc40a117b7a7380463e4574 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 23 Jan 2026 17:10:25 +0000 Subject: [PATCH 2/2] Add report formatting guidelines to copilot-cli-deep-research workflow Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com> --- .../copilot-cli-deep-research.lock.yml | 205 ++++++++++++++++++ .../workflows/copilot-cli-deep-research.md | 131 +++++++++++ 2 files changed, 336 insertions(+) diff --git a/.github/workflows/copilot-cli-deep-research.lock.yml b/.github/workflows/copilot-cli-deep-research.lock.yml index d374f4e3359..ed6407b181e 100644 --- a/.github/workflows/copilot-cli-deep-research.lock.yml +++ b/.github/workflows/copilot-cli-deep-research.lock.yml @@ -20,6 +20,10 @@ # For more information: https://github.com/githubnext/gh-aw/blob/main/.github/aw/github-agentic-workflows.md # # Deep research analyzing Copilot CLI current state, available features, and missed optimization opportunities +# +# Resolved workflow manifest: +# Imports: +# - shared/reporting.md name: "Copilot CLI Deep Research Agent" "on": @@ -564,6 +568,76 @@ jobs: PROMPT_EOF cat << 'PROMPT_EOF' >> "$GH_AW_PROMPT" + ## Report Structure Guidelines + + ### 1. Header Levels + **Use h3 (###) or lower for all headers in your issue report to maintain proper document hierarchy.** + + When creating GitHub issues or discussions: + - Use `###` (h3) for main sections (e.g., "### Test Summary") + - Use `####` (h4) for subsections (e.g., "#### Device-Specific Results") + - Never use `##` (h2) or `#` (h1) in reports - these are reserved for titles + + ### 2. Progressive Disclosure + **Wrap detailed test results in `
Section Name` tags to improve readability and reduce scrolling.** + + Use collapsible sections for: + - Verbose details (full test logs, raw data) + - Secondary information (minor warnings, extra context) + - Per-item breakdowns when there are many items + + Always keep critical information visible (summary, critical issues, key metrics). + + ### 3. Report Structure Pattern + + 1. **Overview**: 1-2 paragraphs summarizing key findings + 2. **Critical Information**: Show immediately (summary stats, critical issues) + 3. **Details**: Use `
Section Name` for expanded content + 4. **Context**: Add helpful metadata (workflow run, date, trigger) + + ### Design Principles (Airbnb-Inspired) + + Reports should: + - **Build trust through clarity**: Most important info immediately visible + - **Exceed expectations**: Add helpful context like trends, comparisons + - **Create delight**: Use progressive disclosure to reduce overwhelm + - **Maintain consistency**: Follow patterns across all reports + + ### Example Report Structure + + ```markdown + ### Summary + - Key metric 1: value + - Key metric 2: value + - Status: ✅/⚠️/❌ + + ### Critical Issues + [Always visible - these are important] + +
+ View Detailed Results + + [Comprehensive details, logs, traces] + +
+ +
+ View All Warnings + + [Minor issues and potential problems] + +
+ + ### Recommendations + [Actionable next steps - keep visible] + ``` + + ## Workflow Run References + + - Format run IDs as links: `[§12345](https://github.com/owner/repo/actions/runs/12345)` + - Include up to 3 most relevant run URLs at end under `**References:**` + - Do NOT add footer attribution (system adds automatically) + # Copilot CLI Deep Research Agent You are a research agent tasked with performing a comprehensive analysis of GitHub Copilot CLI (the agentic coding agent) usage in this repository. Your goal is to identify missed opportunities, unused features, and potential optimizations. @@ -717,6 +791,77 @@ jobs: - Track which recommendations have been implemented - Note new features as they're added + ## Report Formatting Guidelines + + ### Header Levels + **Use h3 (###) or lower for all headers in research reports to maintain proper document hierarchy.** + + Research reports have complex structures (executive summary, detailed findings, methodology, appendices). Proper header levels prevent breaking the document hierarchy. + + ### Progressive Disclosure + **Wrap detailed research sections in `
Section Name` tags to improve readability and focus.** + + Research reports are naturally long and detailed. Progressive disclosure allows readers to get the executive summary and key findings quickly, while deep-dive sections remain accessible but hidden by default. + + Example: + ```markdown +
+ View Complete Research Methodology + + [Detailed explanation of research methods, data collection, analysis techniques] + +
+ ``` + + ### Research Report Structure Pattern + + Use this structure for comprehensive research reports: + + ```markdown + ### Executive Summary + - **Research Topic**: [topic] + - **Key Findings**: [3-5 main discoveries] + - **Recommendation**: [primary recommendation] + + ### Critical Findings + [Most important discoveries - always visible for quick scanning] + +
+ View Detailed Analysis + + [In-depth analysis with data, charts, technical details] + +
+ +
+ View Supporting Evidence + + [Raw data, code examples, test results, screenshots] + +
+ +
+ View Research Methodology + + [How the research was conducted, tools used, data sources] + +
+ + ### Recommendations + [Actionable next steps based on findings - keep visible] + + ### Future Research + [Suggested follow-up topics and questions] + ``` + + ### Design Principles + + Create reports that: + 1. **Build trust through clarity**: Executive summary and critical findings immediately visible + 2. **Exceed expectations**: Include methodology, supporting evidence, future research directions + 3. **Create delight**: Use progressive disclosure to accommodate both quick readers and deep divers + 4. **Maintain consistency**: Follow the same patterns as other research/analysis workflows + ## Output Format Create a GitHub discussion with your comprehensive findings: @@ -737,23 +882,47 @@ jobs: ## 📊 Executive Summary + **Research Topic**: Copilot CLI Optimization Opportunities + **Key Findings**: [3-5 main discoveries] + **Primary Recommendation**: [Most important actionable recommendation] + [2-3 paragraphs summarizing key findings, most important opportunities, and overall assessment] --- + ## Critical Findings + + ### 🔴 High Priority Issues + [Most important issues that need immediate attention - keep visible] + + ### 🟡 Medium Priority Opportunities + [Important but not urgent optimizations - keep visible] + + --- + ## 1️⃣ Current State Analysis +
+ View Copilot CLI Capabilities Inventory + ### Copilot CLI Capabilities Inventory - **Version Information**: [Current version used] - **Available Features**: [List of all documented features] - **Configuration Options**: [CLI flags, engine config, etc.] +
+ +
+ View Usage Statistics + ### Usage Statistics - **Total Workflows**: [count] - **Copilot Workflows**: [count] ([percentage]%) - **Most Common Tools**: [list] - **Most Common Configurations**: [patterns] +
+ --- ## 2️⃣ Feature Usage Matrix @@ -770,6 +939,9 @@ jobs: ## 3️⃣ Missed Opportunities +
+ View High Priority Opportunities + ### 🔴 High Priority #### Opportunity 1: [Title] @@ -784,18 +956,33 @@ jobs: [Repeat for each high-priority opportunity] +
+ +
+ View Medium Priority Opportunities + ### 🟡 Medium Priority [Same structure as high priority] +
+ +
+ View Low Priority Opportunities + ### 🟢 Low Priority [Same structure as high priority] +
+ --- ## 4️⃣ Specific Workflow Recommendations +
+ View Workflow-Specific Recommendations + ### Workflow: `example-workflow.md` - **Current State**: [brief description] - **Recommended Changes**: [list of specific improvements] @@ -803,10 +990,15 @@ jobs: [Repeat for notable workflows] +
+ --- ## 5️⃣ Trends & Insights +
+ View Historical Trends + [If previous research exists in repo-memory] - **Changes Since Last Analysis**: [what's improved or changed] - **Adoption Trends**: [are recommendations being implemented?] @@ -815,6 +1007,8 @@ jobs: [If no previous research] - This is the first comprehensive analysis. Future research will track trends. +
+ --- ## 6️⃣ Best Practice Guidelines @@ -843,6 +1037,9 @@ jobs: --- +
+ View Supporting Evidence & Methodology + ## 📚 References - Copilot Engine Documentation: [link] @@ -850,6 +1047,12 @@ jobs: - Related Workflows: [links] - Previous Research: [link to repo-memory if exists] + ## Research Methodology + + [How the research was conducted, tools used, data sources, analysis techniques] + +
+ --- _Generated by Copilot CLI Deep Research (Run: __GH_AW_GITHUB_RUN_ID__)_ @@ -889,6 +1092,8 @@ jobs: - ✅ Use data and statistics to support findings - ✅ Save analysis to repo-memory for future tracking - ✅ Create a well-structured, readable discussion + PROMPT_EOF + cat << 'PROMPT_EOF' >> "$GH_AW_PROMPT" - ✅ Reference actual code and workflows by name - ✅ Include both quick wins and long-term improvements - ✅ Consider security, performance, and developer experience diff --git a/.github/workflows/copilot-cli-deep-research.md b/.github/workflows/copilot-cli-deep-research.md index c155b1f847b..1b415eab272 100644 --- a/.github/workflows/copilot-cli-deep-research.md +++ b/.github/workflows/copilot-cli-deep-research.md @@ -43,6 +43,8 @@ safe-outputs: timeout-minutes: 20 strict: true +imports: + - shared/reporting.md --- # Copilot CLI Deep Research Agent @@ -198,6 +200,77 @@ Use the repo-memory tool to maintain research history: - Track which recommendations have been implemented - Note new features as they're added +## Report Formatting Guidelines + +### Header Levels +**Use h3 (###) or lower for all headers in research reports to maintain proper document hierarchy.** + +Research reports have complex structures (executive summary, detailed findings, methodology, appendices). Proper header levels prevent breaking the document hierarchy. + +### Progressive Disclosure +**Wrap detailed research sections in `
Section Name` tags to improve readability and focus.** + +Research reports are naturally long and detailed. Progressive disclosure allows readers to get the executive summary and key findings quickly, while deep-dive sections remain accessible but hidden by default. + +Example: +```markdown +
+View Complete Research Methodology + +[Detailed explanation of research methods, data collection, analysis techniques] + +
+``` + +### Research Report Structure Pattern + +Use this structure for comprehensive research reports: + +```markdown +### Executive Summary +- **Research Topic**: [topic] +- **Key Findings**: [3-5 main discoveries] +- **Recommendation**: [primary recommendation] + +### Critical Findings +[Most important discoveries - always visible for quick scanning] + +
+View Detailed Analysis + +[In-depth analysis with data, charts, technical details] + +
+ +
+View Supporting Evidence + +[Raw data, code examples, test results, screenshots] + +
+ +
+View Research Methodology + +[How the research was conducted, tools used, data sources] + +
+ +### Recommendations +[Actionable next steps based on findings - keep visible] + +### Future Research +[Suggested follow-up topics and questions] +``` + +### Design Principles + +Create reports that: +1. **Build trust through clarity**: Executive summary and critical findings immediately visible +2. **Exceed expectations**: Include methodology, supporting evidence, future research directions +3. **Create delight**: Use progressive disclosure to accommodate both quick readers and deep divers +4. **Maintain consistency**: Follow the same patterns as other research/analysis workflows + ## Output Format Create a GitHub discussion with your comprehensive findings: @@ -218,23 +291,47 @@ Create a GitHub discussion with your comprehensive findings: ## 📊 Executive Summary +**Research Topic**: Copilot CLI Optimization Opportunities +**Key Findings**: [3-5 main discoveries] +**Primary Recommendation**: [Most important actionable recommendation] + [2-3 paragraphs summarizing key findings, most important opportunities, and overall assessment] --- +## Critical Findings + +### 🔴 High Priority Issues +[Most important issues that need immediate attention - keep visible] + +### 🟡 Medium Priority Opportunities +[Important but not urgent optimizations - keep visible] + +--- + ## 1️⃣ Current State Analysis +
+View Copilot CLI Capabilities Inventory + ### Copilot CLI Capabilities Inventory - **Version Information**: [Current version used] - **Available Features**: [List of all documented features] - **Configuration Options**: [CLI flags, engine config, etc.] +
+ +
+View Usage Statistics + ### Usage Statistics - **Total Workflows**: [count] - **Copilot Workflows**: [count] ([percentage]%) - **Most Common Tools**: [list] - **Most Common Configurations**: [patterns] +
+ --- ## 2️⃣ Feature Usage Matrix @@ -251,6 +348,9 @@ Create a GitHub discussion with your comprehensive findings: ## 3️⃣ Missed Opportunities +
+View High Priority Opportunities + ### 🔴 High Priority #### Opportunity 1: [Title] @@ -265,18 +365,33 @@ Create a GitHub discussion with your comprehensive findings: [Repeat for each high-priority opportunity] +
+ +
+View Medium Priority Opportunities + ### 🟡 Medium Priority [Same structure as high priority] +
+ +
+View Low Priority Opportunities + ### 🟢 Low Priority [Same structure as high priority] +
+ --- ## 4️⃣ Specific Workflow Recommendations +
+View Workflow-Specific Recommendations + ### Workflow: `example-workflow.md` - **Current State**: [brief description] - **Recommended Changes**: [list of specific improvements] @@ -284,10 +399,15 @@ Create a GitHub discussion with your comprehensive findings: [Repeat for notable workflows] +
+ --- ## 5️⃣ Trends & Insights +
+View Historical Trends + [If previous research exists in repo-memory] - **Changes Since Last Analysis**: [what's improved or changed] - **Adoption Trends**: [are recommendations being implemented?] @@ -296,6 +416,8 @@ Create a GitHub discussion with your comprehensive findings: [If no previous research] - This is the first comprehensive analysis. Future research will track trends. +
+ --- ## 6️⃣ Best Practice Guidelines @@ -324,6 +446,9 @@ Based on this research, here are recommended best practices: --- +
+View Supporting Evidence & Methodology + ## 📚 References - Copilot Engine Documentation: [link] @@ -331,6 +456,12 @@ Based on this research, here are recommended best practices: - Related Workflows: [links] - Previous Research: [link to repo-memory if exists] +## Research Methodology + +[How the research was conducted, tools used, data sources, analysis techniques] + +
+ --- _Generated by Copilot CLI Deep Research (Run: ${{ github.run_id }})_