feat: Update README and script to include Collections in customization features
This commit is contained in:
Craig Bekker
parent
1d28548312
commit
6486a8a533
30
README.md
30
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<br><br>**Benefits:**<br>• Automatic inclusion in every chat request<br>• Repository-wide consistency<br>• Multiple implementation options | Create reusable, standalone prompts for specific tasks. Describe *what* should be done with optional task-specific guidelines<br><br>**Benefits:**<br>• Eliminate repetitive prompt writing<br>• Shareable across teams<br>• Support for variables and dependencies | Define chat behavior, available tools, and codebase interaction patterns within specific boundaries for each request<br><br>**Benefits:**<br>• Context-aware assistance<br>• Tool configuration<br>• 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<br><br>**Benefits:**<br>• Automatic inclusion in every chat request<br>• Repository-wide consistency<br>• Multiple implementation options | Create reusable, standalone prompts for specific tasks. Describe *what* should be done with optional task-specific guidelines<br><br>**Benefits:**<br>• Eliminate repetitive prompt writing<br>• Shareable across teams<br>• Support for variables and dependencies | Define chat behavior, available tools, and codebase interaction patterns within specific boundaries for each request<br><br>**Benefits:**<br>• Context-aware assistance<br>• Tool configuration<br>• Role-specific workflows | Curated bundles of domain-specific instructions, prompts, and chat modes organized by technology or workflow<br><br>**Benefits:**<br>• Complete solution packages<br>• Domain-specific expertise<br>• 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
|
||||
|
||||
@ -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
|
||||
- [Contributing Guide](../../CONTRIBUTING.md) - How to contribute to this collection
|
||||
|
||||
@ -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<br><br>**Benefits:**<br>• Automatic inclusion in every chat request<br>• Repository-wide consistency<br>• Multiple implementation options | Create reusable, standalone prompts for specific tasks. Describe *what* should be done with optional task-specific guidelines<br><br>**Benefits:**<br>• Eliminate repetitive prompt writing<br>• Shareable across teams<br>• Support for variables and dependencies | Define chat behavior, available tools, and codebase interaction patterns within specific boundaries for each request<br><br>**Benefits:**<br>• Context-aware assistance<br>• Tool configuration<br>• 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<br><br>**Benefits:**<br>• Automatic inclusion in every chat request<br>• Repository-wide consistency<br>• Multiple implementation options | Create reusable, standalone prompts for specific tasks. Describe *what* should be done with optional task-specific guidelines<br><br>**Benefits:**<br>• Eliminate repetitive prompt writing<br>• Shareable across teams<br>• Support for variables and dependencies | Define chat behavior, available tools, and codebase interaction patterns within specific boundaries for each request<br><br>**Benefits:**<br>• Context-aware assistance<br>• Tool configuration<br>• Role-specific workflows | Curated bundles of domain-specific instructions, prompts, and chat modes organized by technology or workflow<br><br>**Benefits:**<br>• Complete solution packages<br>• Domain-specific expertise<br>• 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);
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user