diff --git a/README.md b/README.md index ffc97f5..78c2c91 100644 --- a/README.md +++ b/README.md @@ -4,29 +4,19 @@ Enhance your GitHub Copilot experience with community-contributed instructions, ## 🎯 GitHub Copilot Customization Features -GitHub Copilot provides three main ways to customize AI responses and tailor assistance to your specific workflows, team guidelines, and project requirements: +GitHub Copilot provides four main ways to customize AI responses and tailor assistance to your specific workflows, team guidelines, and project requirements: -| **📋 [Custom Instructions](#-custom-instructions)** | **🎯 [Reusable Prompts](#-reusable-prompts)** | **🧩 [Custom Chat Modes](#-custom-chat-modes)** | -| --- | --- | --- | -| Define common guidelines for tasks like code generation, reviews, and commit messages. Describe *how* tasks should be performed

**Benefits:**
• Automatic inclusion in every chat request
• Repository-wide consistency
• Multiple implementation options | Create reusable, standalone prompts for specific tasks. Describe *what* should be done with optional task-specific guidelines

**Benefits:**
• Eliminate repetitive prompt writing
• Shareable across teams
• Support for variables and dependencies | Define chat behavior, available tools, and codebase interaction patterns within specific boundaries for each request

**Benefits:**
• Context-aware assistance
• Tool configuration
• Role-specific workflows | +| **📋 [Custom Instructions](#-custom-instructions)** | **🎯 [Reusable Prompts](#-reusable-prompts)** | **🧩 [Custom Chat Modes](#-custom-chat-modes)** | **📁 [Collections](#-collections)** | +| --- | --- | --- | --- | +| Define common guidelines for tasks like code generation, reviews, and commit messages. Describe *how* tasks should be performed

**Benefits:**
• Automatic inclusion in every chat request
• Repository-wide consistency
• Multiple implementation options | Create reusable, standalone prompts for specific tasks. Describe *what* should be done with optional task-specific guidelines

**Benefits:**
• Eliminate repetitive prompt writing
• Shareable across teams
• Support for variables and dependencies | Define chat behavior, available tools, and codebase interaction patterns within specific boundaries for each request

**Benefits:**
• Context-aware assistance
• Tool configuration
• Role-specific workflows | Curated bundles of domain-specific instructions, prompts, and chat modes organized by technology or workflow

**Benefits:**
• Complete solution packages
• Domain-specific expertise
• Pre-configured workflows | -> **💡 Pro Tip:** Custom instructions only affect Copilot Chat (not inline code completions). You can combine all three customization types - use custom instructions for general guidelines, prompt files for specific tasks, and chat modes to control the interaction context. +> **💡 Pro Tip:** Custom instructions only affect Copilot Chat (not inline code completions). You can combine all four customization types - use custom instructions for general guidelines, prompt files for specific tasks, chat modes to control interaction context, and collections for domain-specific workflows. ## 📝 Contributing We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) for details on how to submit new instructions and prompts. -## 📁 Collections - -Curated collections of prompts, instructions, and chat modes organized by specific domains or workflows: - -| Collection | Description | Contents | -| ---------- | ----------- | -------- | -| [Plan](collections/plan/README.md) | A curated collection of GitHub Copilot customizations focused on plan workflows and best practices. | 6 prompts | - -> 💡 **Usage**: Each collection contains domain-specific customizations. Navigate to a collection folder to find its specialized prompts, instructions, and chat modes. - ## 📋 Custom Instructions Team and project-specific instructions to enhance GitHub Copilot's behavior for specific technologies and coding practices: @@ -209,6 +199,16 @@ Custom chat modes define specific behaviors and tools for GitHub Copilot Chat, e > 💡 **Usage**: Create new chat modes using the command `Chat: Configure Chat Modes...`, then switch your chat mode in the Chat input from _Agent_ or _Ask_ to your own mode. +## 📁 Collections + +Curated collections of prompts, instructions, and chat modes organized by specific domains or workflows: + +| Collection | Description | Contents | +| ---------- | ----------- | -------- | +| [Plan](collections/plan/README.md) | A curated collection of GitHub Copilot customizations focused on plan workflows and best practices. | 6 prompts | + +> 💡 **Usage**: Each collection contains domain-specific customizations. Navigate to a collection folder to find its specialized prompts, instructions, and chat modes. + ## 📚 Additional Resources - [VS Code Copilot Customization Documentation](https://code.visualstudio.com/docs/copilot/copilot-customization) - Official Microsoft documentation diff --git a/collections/plan/README.md b/collections/plan/README.md index c2f0946..b8c0e6b 100644 --- a/collections/plan/README.md +++ b/collections/plan/README.md @@ -24,4 +24,4 @@ Ready-to-use prompt templates for this collection: ## 🔗 Related - [Main Repository](../../) - Browse all available customizations -- [Contributing Guide](../../CONTRIBUTING.md) - How to contribute to this collection \ No newline at end of file +- [Contributing Guide](../../CONTRIBUTING.md) - How to contribute to this collection diff --git a/update-readme.js b/update-readme.js index 2accd33..2072909 100755 --- a/update-readme.js +++ b/update-readme.js @@ -11,13 +11,13 @@ Enhance your GitHub Copilot experience with community-contributed instructions, ## 🎯 GitHub Copilot Customization Features -GitHub Copilot provides three main ways to customize AI responses and tailor assistance to your specific workflows, team guidelines, and project requirements: +GitHub Copilot provides four main ways to customize AI responses and tailor assistance to your specific workflows, team guidelines, and project requirements: -| **📋 [Custom Instructions](#-custom-instructions)** | **🎯 [Reusable Prompts](#-reusable-prompts)** | **🧩 [Custom Chat Modes](#-custom-chat-modes)** | -| --- | --- | --- | -| Define common guidelines for tasks like code generation, reviews, and commit messages. Describe *how* tasks should be performed

**Benefits:**
• Automatic inclusion in every chat request
• Repository-wide consistency
• Multiple implementation options | Create reusable, standalone prompts for specific tasks. Describe *what* should be done with optional task-specific guidelines

**Benefits:**
• Eliminate repetitive prompt writing
• Shareable across teams
• Support for variables and dependencies | Define chat behavior, available tools, and codebase interaction patterns within specific boundaries for each request

**Benefits:**
• Context-aware assistance
• Tool configuration
• Role-specific workflows | +| **📋 [Custom Instructions](#-custom-instructions)** | **🎯 [Reusable Prompts](#-reusable-prompts)** | **🧩 [Custom Chat Modes](#-custom-chat-modes)** | **📁 [Collections](#-collections)** | +| --- | --- | --- | --- | +| Define common guidelines for tasks like code generation, reviews, and commit messages. Describe *how* tasks should be performed

**Benefits:**
• Automatic inclusion in every chat request
• Repository-wide consistency
• Multiple implementation options | Create reusable, standalone prompts for specific tasks. Describe *what* should be done with optional task-specific guidelines

**Benefits:**
• Eliminate repetitive prompt writing
• Shareable across teams
• Support for variables and dependencies | Define chat behavior, available tools, and codebase interaction patterns within specific boundaries for each request

**Benefits:**
• Context-aware assistance
• Tool configuration
• Role-specific workflows | Curated bundles of domain-specific instructions, prompts, and chat modes organized by technology or workflow

**Benefits:**
• Complete solution packages
• Domain-specific expertise
• Pre-configured workflows | -> **💡 Pro Tip:** Custom instructions only affect Copilot Chat (not inline code completions). You can combine all three customization types - use custom instructions for general guidelines, prompt files for specific tasks, and chat modes to control the interaction context. +> **💡 Pro Tip:** Custom instructions only affect Copilot Chat (not inline code completions). You can combine all four customization types - use custom instructions for general guidelines, prompt files for specific tasks, chat modes to control interaction context, and collections for domain-specific workflows. ## 📝 Contributing @@ -647,11 +647,6 @@ function generateReadme() { // Build the complete README content with template sections let readmeContent = [TEMPLATES.header]; - // Add collections section first if we have any - if (collectionsSection) { - readmeContent.push(collectionsSection); - } - // Add main sections if (instructionsSection) { readmeContent.push(instructionsSection); @@ -666,6 +661,11 @@ function generateReadme() { readmeContent.push(chatmodesSection); } + // Add collections section after chat modes if we have any + if (collectionsSection) { + readmeContent.push(collectionsSection); + } + // Add footer readmeContent.push(TEMPLATES.footer);