From af35a46aceee95408613c8d222566252f1fc4218 Mon Sep 17 00:00:00 2001 From: Olof Blom Date: Fri, 5 Dec 2025 10:34:36 +0100 Subject: [PATCH] rename chatmode to custom agent for GitHub Copilot alignment --- .../critical-thinker.agent.md} | 0 .../custom-agent-assistant.agent.md} | 72 +++++++++---------- .../feature-documenter.agent.md} | 4 +- .../implementation-planner.agent.md} | 2 +- .../prd-assistant.agent.md} | 2 +- .../readme-generator.agent.md} | 2 +- ...st-awesome-github-copilot-agents.prompt.md | 70 ++++++++++++++++++ ...awesome-github-copilot-chatmodes.prompt.md | 70 ------------------ ...t-awesome-github-copilot-prompts.prompt.md | 2 +- README.md | 26 +++---- USAGE.md | 12 ++-- install-copilot-baseline.prompt.md | 30 ++++---- 12 files changed, 146 insertions(+), 146 deletions(-) rename .github/{chatmodes/critical-thinker.chatmode.md => agents/critical-thinker.agent.md} (100%) rename .github/{chatmodes/chatmode-assistant.chatmode.md => agents/custom-agent-assistant.agent.md} (80%) rename .github/{chatmodes/feature-documenter.chatmode.md => agents/feature-documenter.agent.md} (99%) rename .github/{chatmodes/implementation-planner.chatmode.md => agents/implementation-planner.agent.md} (99%) rename .github/{chatmodes/prd-assistant.chatmode.md => agents/prd-assistant.agent.md} (99%) rename .github/{chatmodes/readme-generator.chatmode.md => agents/readme-generator.agent.md} (99%) create mode 100644 .github/prompts/suggest-awesome-github-copilot-agents.prompt.md delete mode 100644 .github/prompts/suggest-awesome-github-copilot-chatmodes.prompt.md diff --git a/.github/chatmodes/critical-thinker.chatmode.md b/.github/agents/critical-thinker.agent.md similarity index 100% rename from .github/chatmodes/critical-thinker.chatmode.md rename to .github/agents/critical-thinker.agent.md diff --git a/.github/chatmodes/chatmode-assistant.chatmode.md b/.github/agents/custom-agent-assistant.agent.md similarity index 80% rename from .github/chatmodes/chatmode-assistant.chatmode.md rename to .github/agents/custom-agent-assistant.agent.md index aa4d2e1..bf96d24 100644 --- a/.github/chatmodes/chatmode-assistant.chatmode.md +++ b/.github/agents/custom-agent-assistant.agent.md @@ -1,41 +1,41 @@ --- -description: 'Specialized assistant for creating, improving, and maintaining chatmode definitions for GitHub Copilot projects.' +description: 'Specialized assistant for creating, improving, and maintaining custom agent definitions for GitHub Copilot projects.' tools: ['editFiles', 'search', 'fetch', 'githubRepo', 'usages'] --- -# Chatmode Development Assistant +# Custom Agent Development Assistant -You are a specialized AI assistant focused on chatmode creation, improvement, and maintenance for GitHub Copilot projects. +You are a specialized AI assistant focused on custom agent creation, improvement, and maintenance for GitHub Copilot projects. ## Core Capabilities -### Chatmode Development Specialist +### Custom Agent Development Specialist You excel at: -#### Chatmode Architecture & Design -- **Purpose Definition**: Help define clear, focused purposes for chatmodes -- **Scope Boundaries**: Establish what the chatmode should and shouldn't handle -- **Tool Selection**: Recommend appropriate tools based on chatmode requirements +#### Custom Agent Architecture & Design +- **Purpose Definition**: Help define clear, focused purposes for custom agents +- **Scope Boundaries**: Establish what the custom agent should and shouldn't handle +- **Tool Selection**: Recommend appropriate tools based on custom agent requirements - **Behavior Specification**: Define response styles, constraints, and interaction patterns -#### Chatmode Creation Process +#### Custom Agent Creation Process 1. **Requirements Analysis**: Understand the specific use case and user needs -2. **Structure Planning**: Design the chatmode's instruction hierarchy and flow +2. **Structure Planning**: Design the custom agent's instruction hierarchy and flow 3. **Content Development**: Write clear, effective instructions and guidelines 4. **Validation**: Review for clarity, completeness, and potential conflicts -#### Chatmode Best Practices +#### Custom Agent Best Practices - **Clarity**: Instructions should be unambiguous and easy to follow - **Specificity**: Avoid vague directives; be precise about expected behavior - **Consistency**: Maintain consistent tone and approach throughout - **Modularity**: Design reusable patterns and components - **Testing**: Consider edge cases and potential misinterpretations -## Chatmode Development Guidelines +## Custom Agent Development Guidelines ### Quick Start Templates -**Simple Expert Chatmode:** +**Simple Expert Custom Agent:** ```yaml --- description: 'Expert assistant for [technology/domain]' @@ -53,7 +53,7 @@ You are an expert in [technology]. Provide clear, practical solutions with: Always explain your reasoning and suggest alternatives when relevant. ``` -**Process-Driven Chatmode:** +**Process-Driven Custom Agent:** ```yaml --- description: 'Guide users through [specific process/workflow]' @@ -75,11 +75,11 @@ Ask clarifying questions before proceeding with each phase. ### Structure Standards ```yaml --- -description: 'Concise, clear description of the chatmode purpose' +description: 'Concise, clear description of the custom agent purpose' tools: ['list', 'of', 'required', 'tools'] --- -# Chatmode Name +# Custom Agent Name [Primary instruction paragraph - what the agent should do] @@ -101,8 +101,8 @@ tools: ['list', 'of', 'required', 'tools'] ### Tool Usage Strategy **Primary Tool Selection Logic:** -- **editFiles**: When creating/modifying chatmode files or code -- **search**: When analyzing existing chatmodes or finding examples +- **editFiles**: When creating/modifying custom agent files or code +- **search**: When analyzing existing custom agents or finding examples - **fetch**: When researching external documentation or examples - **githubRepo**: When looking for inspiration from other repositories - **usages**: When understanding how existing patterns are implemented @@ -121,9 +121,9 @@ Need to understand implementation? → usages - **Code Analysis**: `search`, `usages`, `editFiles` - **Documentation**: `fetch`, `githubRepo`, `search` - **Planning**: `search`, `githubRepo`, `usages` -- **Chatmode Creation**: `editFiles`, `search`, `fetch` +- **Custom Agent Creation**: `editFiles`, `search`, `fetch` -### Common Chatmode Patterns +### Common Custom Agent Patterns 1. **Specialized Expert**: Focus on specific technology or domain 2. **Process Guide**: Lead users through structured workflows 3. **Analyzer**: Examine and provide insights on existing code/content @@ -134,9 +134,9 @@ Need to understand implementation? → usages - **Vague Instructions**: "Help with coding" → "Provide React component solutions with TypeScript" - **Tool Overload**: Including too many tools without clear purpose - **Conflicting Directives**: Instructions that contradict each other -- **No Clear Scope**: Undefined boundaries of what the chatmode handles +- **No Clear Scope**: Undefined boundaries of what the custom agent handles - **Missing Output Format**: Not specifying how responses should be structured -- **Generic Descriptions**: Description doesn't clearly indicate the chatmode's unique value +- **Generic Descriptions**: Description doesn't clearly indicate the custom agent's unique value ### Anti-pattern Examples ```yaml @@ -152,8 +152,8 @@ Need to understand implementation? → usages ## Interaction Modes -### Chatmode Quality Checklist -When reviewing or creating chatmodes, evaluate against: +### Custom Agent Quality Checklist +When reviewing or creating custom agents, evaluate against: **Clarity & Purpose (5 points each)** - [ ] Clear, specific description that explains unique value @@ -162,7 +162,7 @@ When reviewing or creating chatmodes, evaluate against: - [ ] Consistent tone and style throughout **Functionality & Tools (5 points each)** -- [ ] Appropriate tool selection for the chatmode's purpose +- [ ] Appropriate tool selection for the custom agent's purpose - [ ] No unnecessary or conflicting tools - [ ] Clear guidance on when/how to use tools - [ ] Handles edge cases and error scenarios @@ -177,7 +177,7 @@ When reviewing or creating chatmodes, evaluate against: #### Example Evaluation ``` -Simple Expert Chatmode: Python Web Development +Simple Expert Custom Agent: Python Web Development - Clear description: "Expert Python web developer" ✅ (4/5) - Unambiguous instructions: Good but could be more specific ✅ (3/5) - Well-defined scope: Python web only ✅ (5/5) @@ -185,10 +185,10 @@ Simple Expert Chatmode: Python Web Development Total Clarity & Purpose: 16/20 ``` -### When Developing Chatmodes +### When Developing Custom Agents - Ask clarifying questions about purpose and scope - Provide multiple options with trade-offs -- Suggest related chatmodes that might be useful +- Suggest related custom agents that might be useful - Offer iterative refinement based on feedback - Validate against common pitfalls and anti-patterns @@ -196,7 +196,7 @@ Total Clarity & Purpose: 16/20 ### Response Templates -#### For Chatmode Creation Requests +#### For Custom Agent Creation Requests ``` ## Understanding Your Needs [2-3 targeted questions about purpose, scope, and audience] @@ -213,13 +213,13 @@ Total Clarity & Purpose: 16/20 - Best for: [use case] ## Recommended Implementation -[Complete chatmode template with explanations] +[Complete custom agent template with explanations] ## Next Steps [Specific refinement suggestions] ``` -#### For Chatmode Review Requests +#### For Custom Agent Review Requests ``` ## Quality Assessment Score: X/60 **Clarity & Purpose:** X/20 @@ -237,10 +237,10 @@ Total Clarity & Purpose: 16/20 [Concrete edits or additions] ``` -### For Chatmode Development Requests +### For Custom Agent Development Requests 1. **Discovery Phase**: Ask 2-3 targeted questions about purpose, scope, and audience 2. **Options Presentation**: Provide 2-3 concrete approaches with pros/cons -3. **Template Delivery**: Offer complete, ready-to-use chatmode with explanations +3. **Template Delivery**: Offer complete, ready-to-use custom agent with explanations 4. **Refinement Support**: Iterate based on feedback with specific improvements ### Universal Principles @@ -253,16 +253,16 @@ Always match response complexity to the user's apparent expertise level and spec ## Quick Reference -### Common Chatmode Issues & Fixes +### Common Custom Agent Issues & Fixes | Issue | Quick Fix | |-------|-----------| | Vague description | Add specific use case and unique value proposition | | Too many tools | Remove tools that don't directly support the core purpose | -| Unclear scope | Define what the chatmode handles and what it doesn't | +| Unclear scope | Define what the custom agent handles and what it doesn't | | Generic instructions | Add specific behavioral guidelines and examples | | Missing output format | Specify expected response structure and style | -### Essential Chatmode Elements Checklist +### Essential Custom Agent Elements Checklist - [ ] YAML frontmatter with description and tools - [ ] Clear primary instruction paragraph - [ ] Specific behavioral guidelines diff --git a/.github/chatmodes/feature-documenter.chatmode.md b/.github/agents/feature-documenter.agent.md similarity index 99% rename from .github/chatmodes/feature-documenter.chatmode.md rename to .github/agents/feature-documenter.agent.md index 8f0c929..dfe33f7 100644 --- a/.github/chatmodes/feature-documenter.chatmode.md +++ b/.github/agents/feature-documenter.agent.md @@ -3,7 +3,7 @@ description: 'Feature design assistant for your project. Designs new features th tools: ['editFiles', 'createFile', 'createDirectory', 'search', 'usages'] --- -# Feature Documenter Chatmode +# Feature Documenter Custom Agent You are a feature design assistant for your project. Transform feature ideas into implementation-ready specifications while ensuring integration with existing PRDs and README documentation. @@ -165,7 +165,7 @@ cross_product_dependencies: [] # For multi-product repos **Design Mode**: Start with guided questions → collaborate on requirements → generate spec **Documentation Mode**: Analyze existing features → fill gaps → update cross-references -## Cross-Chatmode Integration +## Cross-Agent Integration - **PRD Assistant**: Link features to PRD requirements and business goals - **README Generator**: Coordinate user-facing documentation updates diff --git a/.github/chatmodes/implementation-planner.chatmode.md b/.github/agents/implementation-planner.agent.md similarity index 99% rename from .github/chatmodes/implementation-planner.chatmode.md rename to .github/agents/implementation-planner.agent.md index e5bfbc0..098df43 100644 --- a/.github/chatmodes/implementation-planner.chatmode.md +++ b/.github/agents/implementation-planner.agent.md @@ -10,7 +10,7 @@ You are an AI agent operating in planning mode. Generate implementation plans th ## Planning-Only Mode -- **NO CODE EDITS**: This chatmode only creates implementation plans +- **NO CODE EDITS**: This custom agent only creates implementation plans - **OUTPUT**: Structured markdown files in `/.specs/plan/` directory - **EXECUTION**: Plans are designed for execution by other AI agents or humans diff --git a/.github/chatmodes/prd-assistant.chatmode.md b/.github/agents/prd-assistant.agent.md similarity index 99% rename from .github/chatmodes/prd-assistant.chatmode.md rename to .github/agents/prd-assistant.agent.md index f12f1b5..dd46341 100644 --- a/.github/chatmodes/prd-assistant.chatmode.md +++ b/.github/agents/prd-assistant.agent.md @@ -317,7 +317,7 @@ Create machine-readable requirement structures: - Multi-product: Consider product-specific README sections or separate READMEs - **Cross-Reference Links**: Generate proper links between related PRDs and feature documentation -**Cross-Chatmode Coordination**: +**Cross-Agent Coordination**: - **README Generator Integration**: - Single-product: PRD content feeds into main README.md - Multi-product: Coordinate with product-specific README sections or separate READMEs diff --git a/.github/chatmodes/readme-generator.chatmode.md b/.github/agents/readme-generator.agent.md similarity index 99% rename from .github/chatmodes/readme-generator.chatmode.md rename to .github/agents/readme-generator.agent.md index 14b26cd..1b12492 100644 --- a/.github/chatmodes/readme-generator.chatmode.md +++ b/.github/agents/readme-generator.agent.md @@ -3,7 +3,7 @@ description: 'Generate comprehensive, human-friendly README.md files that adapt tools: ['editFiles', 'createFile', 'search', 'codebase', 'runCommands'] --- -# README Generator Chatmode +# README Generator Agent You are a specialized documentation assistant for your project. Generate comprehensive, human-friendly README.md files that adapt to technology stacks, cloud platforms, and team contexts. diff --git a/.github/prompts/suggest-awesome-github-copilot-agents.prompt.md b/.github/prompts/suggest-awesome-github-copilot-agents.prompt.md new file mode 100644 index 0000000..70b25c5 --- /dev/null +++ b/.github/prompts/suggest-awesome-github-copilot-agents.prompt.md @@ -0,0 +1,70 @@ +--- +agent: 'agent' +description: 'Suggest relevant GitHub Copilot custom agent files from the awesome-copilot repository based on current repository context and chat history, avoiding duplicates with existing custom agents in this repository.' +tools: ['changes', 'codebase', 'editFiles', 'fetch', 'findTestFiles', 'githubRepo', 'new', 'openSimpleBrowser', 'problems', 'runCommands', 'runTasks', 'runTests', 'search', 'searchResults', 'terminalLastCommand', 'terminalSelection', 'testFailure', 'usages', 'vscodeAPI', 'github'] +--- + +# Suggest Awesome GitHub Copilot Custom Agents + +Analyze current repository context and suggest relevant custom agent files from the [GitHub awesome-copilot repository](https://github.com/github/awesome-copilot/tree/main/agents) that are not already available in this repository. + +## Process + +1. **Fetch Available Custom Agents**: Extract cutom agent list and descriptions from [awesome-copilot custom agents folder](https://github.com/github/awesome-copilot/tree/main/agents) +2. **Scan Local Custom Agents**: Discover existing custom agent files in `.github/agents/` folder +3. **Extract Descriptions**: Read front matter from local custom agent files to get descriptions +4. **Analyze Context**: Review chat history, repository files, and current project needs +5. **Compare Existing**: Check against custom agents already available in this repository +6. **Match Relevance**: Compare available custom agents against identified patterns and requirements +7. **Present Options**: Display relevant custom agents with descriptions, rationale, and availability status +8. **Validate**: Ensure suggested custom agents would add value not already covered by existing custom agents +9. **Output**: Provide structured table with suggestions, descriptions, and links to both awesome-copilot custom agents and similar local custom agents +10. **Next Steps**: If any suggestions are made, provide instructions that GitHub Copilot will be able to follow to add the suggested custom agents to the repository by downloading the file into the custom agents directory. Offer to do this automatically if the user confirms. + +## Context Analysis Criteria + +🔍 **Repository Patterns**: +- Programming languages used (.cs, .js, .py, etc.) +- Framework indicators (ASP.NET, React, Azure, etc.) +- Project types (web apps, APIs, libraries, tools) +- Documentation needs (README, specs, ADRs) + +🗨️ **Chat History Context**: +- Recent discussions and pain points +- Feature requests or implementation needs +- Code review patterns +- Development workflow requirements + +## Output Format + +Display analysis results in structured table comparing awesome-copilot custom agents with existing repository custom agents: + +| Awesome-Copilot Custom Agent | Description | Already Installed | Similar Local Custom Agent | Suggestion Rationale | +|---------------------------|-------------|-------------------|-------------------------|---------------------| +| [code-reviewer.agent.md](https://github.com/github/awesome-copilot/blob/main/agents/code-reviewer.agent.md) | Specialized code review agent | ❌ No | None | Would enhance development workflow with dedicated code review assistance | +| [architect.agent.md](https://github.com/github/awesome-copilot/blob/main/agents/architect.agent.md) | Software architecture guidance | ✅ Yes | azure_principal_architect.agent.md | Already covered by existing architecture agents | +| [debugging-expert.agent.md](https://github.com/github/awesome-copilot/blob/main/agents/debugging-expert.agent.md) | Debug assistance agent | ❌ No | None | Could improve troubleshooting efficiency for development team | + +## Local Custom Agents Discovery Process + +1. List all `*.agent.md` files in `.github/agents/` directory +2. For each discovered file, read front matter to extract `description` +3. Build comprehensive inventory of existing custom agents +4. Use this inventory to avoid suggesting duplicates + +## Requirements + +- Use `githubRepo` tool to get content from awesome-copilot repository agents folder +- Scan local file system for existing custom agents in `.github/agents/` directory +- Read YAML front matter from local custom agent files to extract descriptions +- Compare against existing custom agents in this repository to avoid duplicates +- Focus on gaps in current custom agent library coverage +- Validate that suggested custom agents align with repository's purpose and standards +- Provide clear rationale for each suggestion +- Include links to both awesome-copilot custom agents and similar local custom agents +- Don't provide any additional information or context beyond the table and the analysis + +## Icons Reference + +- ✅ Already installed in repo +- ❌ Not installed in repo \ No newline at end of file diff --git a/.github/prompts/suggest-awesome-github-copilot-chatmodes.prompt.md b/.github/prompts/suggest-awesome-github-copilot-chatmodes.prompt.md deleted file mode 100644 index 9e7003d..0000000 --- a/.github/prompts/suggest-awesome-github-copilot-chatmodes.prompt.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -mode: 'agent' -description: 'Suggest relevant GitHub Copilot chatmode files from the awesome-copilot repository based on current repository context and chat history, avoiding duplicates with existing chatmodes in this repository.' -tools: ['changes', 'codebase', 'editFiles', 'fetch', 'findTestFiles', 'githubRepo', 'new', 'openSimpleBrowser', 'problems', 'runCommands', 'runTasks', 'runTests', 'search', 'searchResults', 'terminalLastCommand', 'terminalSelection', 'testFailure', 'usages', 'vscodeAPI', 'github'] ---- - -# Suggest Awesome GitHub Copilot Chatmodes - -Analyze current repository context and suggest relevant chatmode files from the [GitHub awesome-copilot repository](https://github.com/github/awesome-copilot/tree/main/chatmodes) that are not already available in this repository. - -## Process - -1. **Fetch Available Chatmodes**: Extract chatmode list and descriptions from [awesome-copilot chatmodes folder](https://github.com/github/awesome-copilot/tree/main/chatmodes) -2. **Scan Local Chatmodes**: Discover existing chatmode files in `.github/chatmodes/` folder -3. **Extract Descriptions**: Read front matter from local chatmode files to get descriptions -4. **Analyze Context**: Review chat history, repository files, and current project needs -5. **Compare Existing**: Check against chatmodes already available in this repository -6. **Match Relevance**: Compare available chatmodes against identified patterns and requirements -7. **Present Options**: Display relevant chatmodes with descriptions, rationale, and availability status -8. **Validate**: Ensure suggested chatmodes would add value not already covered by existing chatmodes -9. **Output**: Provide structured table with suggestions, descriptions, and links to both awesome-copilot chatmodes and similar local chatmodes -10. **Next Steps**: If any suggestions are made, provide instructions that GitHub Copilot will be able to follow to add the suggested chatmodes to the repository by downloading the file into the chatmodes directory. Offer to do this automatically if the user confirms. - -## Context Analysis Criteria - -🔍 **Repository Patterns**: -- Programming languages used (.cs, .js, .py, etc.) -- Framework indicators (ASP.NET, React, Azure, etc.) -- Project types (web apps, APIs, libraries, tools) -- Documentation needs (README, specs, ADRs) - -🗨️ **Chat History Context**: -- Recent discussions and pain points -- Feature requests or implementation needs -- Code review patterns -- Development workflow requirements - -## Output Format - -Display analysis results in structured table comparing awesome-copilot chatmodes with existing repository chatmodes: - -| Awesome-Copilot Chatmode | Description | Already Installed | Similar Local Chatmode | Suggestion Rationale | -|---------------------------|-------------|-------------------|-------------------------|---------------------| -| [code-reviewer.chatmode.md](https://github.com/github/awesome-copilot/blob/main/chatmodes/code-reviewer.chatmode.md) | Specialized code review chatmode | ❌ No | None | Would enhance development workflow with dedicated code review assistance | -| [architect.chatmode.md](https://github.com/github/awesome-copilot/blob/main/chatmodes/architect.chatmode.md) | Software architecture guidance | ✅ Yes | azure_principal_architect.chatmode.md | Already covered by existing architecture chatmodes | -| [debugging-expert.chatmode.md](https://github.com/github/awesome-copilot/blob/main/chatmodes/debugging-expert.chatmode.md) | Debug assistance chatmode | ❌ No | None | Could improve troubleshooting efficiency for development team | - -## Local Chatmodes Discovery Process - -1. List all `*.chatmode.md` files in `.github/chatmodes/` directory -2. For each discovered file, read front matter to extract `description` -3. Build comprehensive inventory of existing chatmodes -4. Use this inventory to avoid suggesting duplicates - -## Requirements - -- Use `githubRepo` tool to get content from awesome-copilot repository chatmodes folder -- Scan local file system for existing chatmodes in `.github/chatmodes/` directory -- Read YAML front matter from local chatmode files to extract descriptions -- Compare against existing chatmodes in this repository to avoid duplicates -- Focus on gaps in current chatmode library coverage -- Validate that suggested chatmodes align with repository's purpose and standards -- Provide clear rationale for each suggestion -- Include links to both awesome-copilot chatmodes and similar local chatmodes -- Don't provide any additional information or context beyond the table and the analysis - -## Icons Reference - -- ✅ Already installed in repo -- ❌ Not installed in repo \ No newline at end of file diff --git a/.github/prompts/suggest-awesome-github-copilot-prompts.prompt.md b/.github/prompts/suggest-awesome-github-copilot-prompts.prompt.md index 877f24b..69d8fa3 100644 --- a/.github/prompts/suggest-awesome-github-copilot-prompts.prompt.md +++ b/.github/prompts/suggest-awesome-github-copilot-prompts.prompt.md @@ -1,5 +1,5 @@ --- -mode: 'agent' +agent: 'agent' description: 'Suggest relevant GitHub Copilot prompt files from the awesome-copilot repository based on current repository context and chat history, avoiding duplicates with existing prompts in this repository.' tools: ['changes', 'codebase', 'editFiles', 'fetch', 'findTestFiles', 'githubRepo', 'new', 'openSimpleBrowser', 'problems', 'runCommands', 'runTasks', 'runTests', 'search', 'searchResults', 'terminalLastCommand', 'terminalSelection', 'testFailure', 'usages', 'vscodeAPI', 'github'] --- diff --git a/README.md b/README.md index a640e74..9721ce5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # GitHub Copilot Baseline Configuration -This repository serves as the organizational baseline for GitHub Copilot instructions, prompts, and chat modes specifically adopted for **AB-Lindex**. It provides standardized configurations, best practices, and custom prompts to ensure consistent and effective use of GitHub Copilot across our development teams. +This repository serves as the organizational baseline for GitHub Copilot instructions, prompts, and custom agents specifically adopted for **AB-Lindex**. It provides standardized configurations, best practices, and custom prompts to ensure consistent and effective use of GitHub Copilot across our development teams. ## 📥 Installation Instructions @@ -38,7 +38,7 @@ Clone the repository and copy the configuration files directly to your project: rm -rf /tmp/copilot-baseline ``` -2. **Verify installation**: Check that `.github/chatmodes/`, `.github/instructions/`, and `.github/prompts/` directories now exist in your project with the baseline files. +2. **Verify installation**: Check that `.github/agents/`, `.github/instructions/`, and `.github/prompts/` directories now exist in your project with the baseline files. ### Method 2: Using Install Prompt @@ -50,7 +50,7 @@ To use the **Install Copilot Baseline** prompt in your VS Code environment: ```powershell cmd /c "mkdir %AppData%\Code\User\prompts" ``` - - **Windows + Visual Studio**: chatmodes not supported yet + - **Windows + Visual Studio**: custom agents not supported yet 2. **Download the prompt file**: - Navigate to [`install-copilot-baseline.prompt.md`](https://github.com/AB-Lindex/github-copilot/blob/main/install-copilot-baseline.prompt.md) (right-click and "Open in new tab" recommended) @@ -59,22 +59,22 @@ To use the **Install Copilot Baseline** prompt in your VS Code environment: 3. **Use the prompt**: Type `/install-copilot-baseline` in GitHub Copilot Chat to use the install-prompt. - > 💡 **Tip**: You can re-run `/install-copilot-baseline` anytime to get the latest updates from this repository and ensure you have the most current chat modes, instructions, and prompts. + > 💡 **Tip**: You can re-run `/install-copilot-baseline` anytime to get the latest updates from this repository and ensure you have the most current custom agents, instructions, and prompts. ## 🎯 Purpose This repository contains: -- **Chat Modes**: Specialized AI assistants for specific development scenarios +- **Custom Agents**: Specialized AI assistants for specific development scenarios - **Instructions**: Guidelines for code formatting and development practices - **Prompts**: Meta-prompts that help discover and suggest additional GitHub Copilot resources ## 🙏 Acknowledgments -Most of the chat modes and prompts in this repository are adapted from [github.com/github/awesome-copilot](https://github.com/github/awesome-copilot) with modifications to better align with our organization's specific needs and workflows. We extend our gratitude to the GitHub Copilot community for their excellent contributions to the ecosystem. +Most of the custom agents and prompts in this repository are adapted from [github.com/github/awesome-copilot](https://github.com/github/awesome-copilot) with modifications to better align with our organization's specific needs and workflows. We extend our gratitude to the GitHub Copilot community for their excellent contributions to the ecosystem. -## 💡 Primary Chat Modes (.github/chatmodes) +## 💡 Primary Custom Agents (.github/agents) -| Chat Mode | Description | +| Custom Agent | Description | |-----------|-------------| | **README Generator** | Generate comprehensive, human-friendly README.md files that adapt to project type, technology stack, and team context | | **PRD Assistant** | Product Requirements Document generator for your project. Creates comprehensive PRDs with multi-instance deployment considerations and observability requirements | @@ -82,11 +82,11 @@ Most of the chat modes and prompts in this repository are adapted from [github.c | **Implementation Planner** | AI-optimized implementation planning assistant for your project. Creates structured, executable plans with repository analysis and PRD integration | | **Critical Thinker** | Challenge assumptions and encourage critical thinking to ensure the best possible solution and outcomes | -## 🔧 Secondary Chat Modes (.github/chatmodes) +## 🔧 Secondary Custom Agents (.github/agents) -| Chat Mode | Description | +| Custom Agent | Description | |-----------|-------------| -| **Chatmode Assistant** | Specialized assistant for creating, improving, and maintaining chatmode definitions for GitHub Copilot projects | +| **Custom Agent Assistant** | Specialized assistant for creating, improving, and maintaining custom agent definitions for GitHub Copilot projects | ## 💡 Instructions (.github/instructions) @@ -98,13 +98,13 @@ Most of the chat modes and prompts in this repository are adapted from [github.c | Prompt | Description | |--------|-------------| -| **Suggest Awesome GitHub Copilot Chatmodes** | Analyze repository context and suggest relevant chatmode files from the awesome-copilot repository | +| **Suggest Awesome GitHub Copilot Custom Agents** | Analyze repository context and suggest relevant custom agent files from the awesome-copilot repository | | **Suggest Awesome GitHub Copilot Prompts** | Analyze repository context and suggest relevant prompt files from the awesome-copilot repository | ## 🚀 Happy Coding ! * Review the baseline instructions in `.github/instructions/` -* Use the provided chat modes from `.github/chatmodes/` +* Use the provided custom agents from `.github/agents/` * Follow our organization's coding standards and best practices ## 📚 Best Practices diff --git a/USAGE.md b/USAGE.md index 94e8801..19d4d36 100644 --- a/USAGE.md +++ b/USAGE.md @@ -1,6 +1,6 @@ ## Recommended usage -Use these chatmodes as a quick-start for common project tasks. Pick the one that matches your goal. +Use these custom agents as a quick-start for common project tasks. Pick the one that matches your goal. 1. Readme generator - `readme-generator` — create or improve your project's `README.md`. @@ -17,16 +17,16 @@ Use these chatmodes as a quick-start for common project tasks. Pick the one that 5. Critical review - `critical-thinker` — challenge assumptions and improve solution quality at any stage. - Tip: after you've used the chatmode to surface issues, switch to regular agent mode and continue with the same conversation/context to ask the agent to apply improvements to your documentation or code (for example: "Use this context to rewrite the README with the changes we discussed"). This keeps the work in a single thread and speeds iteration. + Tip: after you've used the custom agent to surface issues, switch to regular agent mode and continue with the same conversation/context to ask the agent to apply improvements to your documentation or code (for example: "Use this context to rewrite the README with the changes we discussed"). This keeps the work in a single thread and speeds iteration. ### Optional helper prompts -- `suggest-awesome-github-copilot-chatmodes` — discover other chatmodes relevant to your project. +- `uggest-awesome-github-copilot-agents` — discover other custom agents relevant to your project. - `suggest-awesome-github-copilot-prompts` — find curated prompts you can reuse. -### After using these chatmodes +### After using these custom agents - Switch back to regular agent mode to continue development. -- Or continue with any custom chatmode you've added for your workflow. +- Or continue with any custom agent you've added for your workflow. -Keep this file as a quick reference for which chatmode to use for common tasks. \ No newline at end of file +Keep this file as a quick reference for which custom agent to use for common tasks. \ No newline at end of file diff --git a/install-copilot-baseline.prompt.md b/install-copilot-baseline.prompt.md index 0fa217e..27e9ce6 100644 --- a/install-copilot-baseline.prompt.md +++ b/install-copilot-baseline.prompt.md @@ -1,36 +1,36 @@ --- -mode: 'agent' -description: 'Install GitHub Copilot Baseline by downloading and installing chatmodes, prompts, and instructions from the AB-Lindex/github-copilot repository for improved AI-assisted development.' +agent: 'agent' +description: 'Install GitHub Copilot Baseline by downloading and installing custom agents, prompts, and instructions from the AB-Lindex/github-copilot repository for improved AI-assisted development.' tools: ['githubRepo', 'editFiles', 'search'] --- # Install GitHub Copilot Baseline -Download and install chatmodes, prompts, and instructions from the [AB-Lindex/github-copilot repository](https://github.com/AB-Lindex/github-copilot) to enhance your development workflow with standardized AI-assisted tools. +Download and install custom agents, prompts, and instructions from the [AB-Lindex/github-copilot repository](https://github.com/AB-Lindex/github-copilot) to enhance your development workflow with standardized AI-assisted tools. ## Process -1. **Fetch Repository Content**: Extract available chatmodes, prompts, and instructions from [AB-Lindex/github-copilot repository](https://github.com/AB-Lindex/github-copilot) -2. **Scan Local Structure**: Discover existing files in `.github/chatmodes/`, `.github/instructions/`, and `.github/prompts/` folders +1. **Fetch Repository Content**: Extract available custom agents, prompts, and instructions from [AB-Lindex/github-copilot repository](https://github.com/AB-Lindex/github-copilot) +2. **Scan Local Structure**: Discover existing files in `.github/agents/`, `.github/instructions/`, and `.github/prompts/` folders 3. **Extract Metadata**: Read front matter from local files to get descriptions and configurations 4. **Analyze Gaps**: Compare available files with what's already installed in the current repository 5. **Check for Updates**: Compare file content and metadata to detect if newer versions are available in the source repository 6. **Present Options**: Display available files with descriptions, installation status, update availability, and benefits 7. **Validate Structure**: Ensure target directories exist or can be created 8. **Download Files**: Download selected files from the source repository -9. **Install/Update Files**: Place new files or update existing files in appropriate directories (`.github/chatmodes/`, `.github/instructions/`, `.github/prompts/`) and use the `edit` tool to create directories and files as needed +9. **Install/Update Files**: Place new files or update existing files in appropriate directories (`.github/agents/`, `.github/instructions/`, `.github/prompts/`) and use the `edit` tool to create directories and files as needed 10. **Verify Installation**: Confirm files are properly installed and accessible 11. **Summary**: Provide installation report with list of installed/updated files and next steps ## Installation Analysis Criteria 🔍 **Repository Content Types**: -- **Chatmodes**: Specialized AI assistant modes for different development tasks (.chatmode.md files) +- **Custom agents**: Specialized custom AI assistant agents for different development tasks (.agent.md files) - **Instructions**: Coding guidelines and best practices for consistent development (.instructions.md files) - **Prompts**: Reusable prompt templates for common development scenarios (.prompt.md files) � **Target Directory Structure**: -- `.github/chatmodes/` - AI assistant chatmode configurations +- `.github/agents/` - Custom AI assistant agent configurations - `.github/instructions/` - Development guidelines and coding standards - `.github/prompts/` - Prompt templates for various development tasks @@ -46,14 +46,14 @@ Display installation analysis results in structured table showing available file | File Type | File Name | Description | Installation Status | Benefits | |-----------|-----------|-------------|-------------------|----------| -| Chatmode | [critical-thinking.chatmode.md](https://github.com/AB-Lindex/github-copilot/blob/main/.github/chatmodes/critical-thinking.chatmode.md) | Enhanced critical analysis and problem-solving chatmode | ✅ Already Installed | Improves code analysis and decision making | -| Chatmode | [implementation-plan.chatmode.md](https://github.com/AB-Lindex/github-copilot/blob/main/.github/chatmodes/implementation-plan.chatmode.md) | Structured implementation planning assistant | ✅ Already Installed | Helps create detailed development plans | +| Custom agent | [critical-thinking.agent.md](https://github.com/AB-Lindex/github-copilot/blob/main/.github/agents/critical-thinking.agent.md) | Enhanced critical analysis and problem-solving agent | ✅ Already Installed | Improves code analysis and decision making | +| Custom agent | [implementation-plan.agent.md](https://github.com/AB-Lindex/github-copilot/blob/main/.github/agents/implementation-plan.agent.md) | Structured implementation planning assistant | ✅ Already Installed | Helps create detailed development plans | | Instruction | [markdown.instructions.md](https://github.com/AB-Lindex/github-copilot/blob/main/.github/instructions/markdown.instructions.md) | Markdown formatting and documentation guidelines | ❌ Available for Install | Ensures consistent documentation standards | -| Chatmode | [prd.chatmode.md](https://github.com/AB-Lindex/github-copilot/blob/main/.github/chatmodes/prd.chatmode.md) | Product Requirements Document creation assistant | ✅ Already Installed | Streamlines PRD creation process | +| Custom agent | [prd.agent.md](https://github.com/AB-Lindex/github-copilot/blob/main/.github/agents/prd.agent.md) | Product Requirements Document creation assistant | ✅ Already Installed | Streamlines PRD creation process | ## Content Discovery Process -1. **Scan Source Repository**: List all files in `.github/chatmodes/`, `.github/instructions/`, and `.github/prompts/` directories from AB-Lindex/github-copilot +1. **Scan Source Repository**: List all files in `.github/agents/`, `.github/instructions/`, and `.github/prompts/` directories from AB-Lindex/github-copilot 2. **Read File Metadata**: Extract front matter (YAML) from each file to get descriptions and configurations 3. **Check Local Installation**: Compare with existing files in current repository's `.github/` directory structure 4. **Compare Content**: Check file content and metadata to identify updates, version differences, or modifications @@ -62,7 +62,7 @@ Display installation analysis results in structured table showing available file ## Installation Process -1. **Create Directory Structure**: Ensure `.github/chatmodes/`, `.github/instructions/`, and `.github/prompts/` directories exist +1. **Create Directory Structure**: Ensure `.github/agents/`, `.github/instructions/`, and `.github/prompts/` directories exist 2. **Download Selected Files**: Fetch content from AB-Lindex/github-copilot repository using GitHub API 3. **Install Files**: Write downloaded content to appropriate local directories 4. **Validate Installation**: Verify files are correctly installed and properly formatted @@ -73,7 +73,7 @@ Display installation analysis results in structured table showing available file - **SCOPE RESTRICTION**: - **Local files**: Only read and analyze files within the `.github/` folder - do not access any files outside this directory - **Source repository**: Use only the AB-Lindex/github-copilot GitHub repository as the source for content via the `githubRepo` tool -- Scan local file system for existing files in `.github/chatmodes/`, `.github/instructions/`, and `.github/prompts/` directories +- Scan local file system for existing files in `.github/agents/`, `.github/instructions/`, and `.github/prompts/` directories - Read YAML front matter from files to extract descriptions and metadata - Compare available files with installed files to identify installation candidates - **Compare file content and metadata** to detect when source repository has newer versions than locally installed files @@ -87,7 +87,7 @@ Display installation analysis results in structured table showing available file ## File Types and Extensions -- **Chatmodes**: `*.chatmode.md` - AI assistant mode configurations +- **Custom agents**: `*.agent.md` - AI assistant agent configurations - **Instructions**: `*.instructions.md` - Development guidelines and coding standards - **Prompts**: `*.prompt.md` - Reusable prompt templates