Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 24 additions & 9 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@ The following instructions are only to be applied when performing a code review.

## README updates

- [ ] The new file should be added to the `README.md`.
- [ ] The new file should be added to the `docs/README.<type>.md`.

## Prompt file guide

**Only apply to files that end in `.prompt.md`**

- [ ] The prompt has markdown front matter.
- [ ] The prompt has a `mode` field specified of either `agent` or `ask`.
- [ ] The prompt has a `agent` field specified of either `agent`, `ask`, or `Plan`.
Copy link

Copilot AI Jan 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammar issue: "a agent" should be "an agent" since "agent" starts with a vowel sound. Additionally, the value "Plan" should be lowercase "plan" for consistency with the other lowercase values "agent" and "ask".

Suggested change
- [ ] The prompt has a `agent` field specified of either `agent`, `ask`, or `Plan`.
- [ ] The prompt has an `agent` field specified of either `agent`, `ask`, or `plan`.

Copilot uses AI. Check for mistakes.
- [ ] The prompt has a `description` field.
- [ ] The `description` field is not empty.
- [ ] The `description` field value is wrapped in single quotes.
- [ ] The file name is lower case, with words separated by hyphens.
- [ ] Encourage the use of `tools`, but it's not required.
- [ ] Strongly encourage the use of `model` to specify the model that the prompt is optimised for.
- [ ] Strongly encourage the use of `name` to set the name for the prompt.

## Instruction file guide

Expand All @@ -24,21 +24,20 @@ The following instructions are only to be applied when performing a code review.
- [ ] The instruction has markdown front matter.
- [ ] The instruction has a `description` field.
- [ ] The `description` field is not empty.
- [ ] The `description` field value is wrapped in single quotes.
- [ ] The file name is lower case, with words separated by hyphens.
- [ ] The instruction has an `applyTo` field that specifies the file or files to which the instructions apply. If they wish to specify multiple file paths they should formated like `'**.js, **.ts'`.

## Chat Mode file guide
## Agent file guide

**Only apply to files that end in `.agent.md`**

- [ ] The chat mode has markdown front matter.
- [ ] The chat mode has a `description` field.
- [ ] The agent has markdown front matter.
- [ ] The agent has a `description` field.
- [ ] The `description` field is not empty.
- [ ] The `description` field value is wrapped in single quotes.
- [ ] The file name is lower case, with words separated by hyphens.
- [ ] Encourage the use of `tools`, but it's not required.
- [ ] Strongly encourage the use of `model` to specify the model that the chat mode is optimised for.
- [ ] Strongly encourage the use of `model` to specify the model that the agent is optimised for.
- [ ] Strongly encourage the use of `name` to set the name for the agent.

## Agent Skills guide

Expand All @@ -55,3 +54,19 @@ The following instructions are only to be applied when performing a code review.
- [ ] The folder name is lower case, with words separated by hyphens.
- [ ] Any bundled assets (scripts, templates, data files) are referenced in the SKILL.md instructions.
- [ ] Bundled assets are reasonably sized (under 5MB per file).

## Collection file guide

**Only apply to files that end in `.collection.yml`**

- [ ] The collection has a `name` field.
- [ ] The collection has a `description` field.
- [ ] The `description` field is not empty.
- [ ] The collection has a `tags` field.
- [ ] The file name is lower case, with words separated by hyphens.
- [ ] Each item in the collection has a `path` field.
- [ ] Each item in the collection has a `kind` field.
- [ ] The `kind` field value is one of: `prompt`, `instruction`, `agent`, or `skill`.
- [ ] The collection does not include duplicate items.
- [ ] The collection does not reference non-existent files.
- [ ] Each item can have an optional `usage` field describing when to use the item.
8 changes: 4 additions & 4 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## Pull Request Checklist

- [ ] I have read and followed the [CONTRIBUTING.md](https://github.com/github/awesome-copilot/blob/main/CONTRIBUTING.md) guidelines.
- [ ] My contribution adds a new instruction, prompt, or chat mode file in the correct directory.
- [ ] My contribution adds a new instruction, prompt, agent, or skill file in the correct directory.
- [ ] The file follows the required naming convention.
- [ ] The content is clearly structured and follows the example format.
- [ ] I have tested my instructions, prompt, or chat mode with GitHub Copilot.
- [ ] I have tested my instructions, prompt, agent, or skill with GitHub Copilot.
- [ ] I have run `npm start` and verified that `README.md` is up to date.

---
Expand All @@ -19,10 +19,10 @@

- [ ] New instruction file.
- [ ] New prompt file.
- [ ] New chat mode file.
- [ ] New agent file.
- [ ] New collection file.
- [ ] New skill file.
- [ ] Update to existing instruction, prompt, chat mode, collection or skill.
- [ ] Update to existing instruction, prompt, agent, collection or skill.
- [ ] Other (please specify):

---
Expand Down
27 changes: 13 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,27 +61,26 @@ Your goal is to...
- Include examples where helpful
```

### Adding Chat Modes
### Adding an Agent

Chat modes are specialized configurations that transform GitHub Copilot Chat into domain-specific assistants or personas for particular development scenarios.
Agents are specialized configurations that transform GitHub Copilot Chat into domain-specific assistants or personas for particular development scenarios.

1. **Create your chat mode file**: Add a new `.agent.md` file in the `agents/` directory
1. **Create your agent file**: Add a new `.agent.md` file in the `agents/` directory
2. **Follow the naming convention**: Use descriptive, lowercase filenames with hyphens and the `.agent.md` extension (e.g., `react-performance-expert.agent.md`)
3. **Include frontmatter**: Add metadata at the top of your file with required fields
4. **Define the persona**: Create a clear identity and expertise area for the chat mode
5. **Test your chat mode**: Ensure the chat mode provides helpful, accurate responses in its domain
4. **Define the persona**: Create a clear identity and expertise area for the agent
5. **Test your agent**: Ensure the agent provides helpful, accurate responses in its domain

#### Example chat mode format
#### Example agent format

```markdown
---
description: 'Brief description of the chat mode and its purpose'
description: 'Brief description of the agent and its purpose'
model: 'gpt-5'
tools: ['codebase', 'terminalCommand']
name: 'My Agent Name'
---

# Chat Mode Title

You are an expert [domain/role] with deep knowledge in [specific areas].

## Your Expertise
Expand Down Expand Up @@ -114,7 +113,7 @@ Skills are self-contained folders in the `skills/` directory that include a `SKI

### Adding Collections

Collections group related prompts, instructions, and chat modes around specific themes or workflows, making it easier for users to discover and adopt comprehensive toolkits.
Collections group related prompts, instructions, agents, and skills around specific themes or workflows, making it easier for users to discover and adopt comprehensive toolkits.

1. **Create your collection manifest**: Add a new `.collection.yml` file in the `collections/` directory
2. **Follow the naming convention**: Use descriptive, lowercase filenames with hyphens (e.g., `python-web-development.collection.yml`)
Expand Down Expand Up @@ -142,17 +141,17 @@ items:
kind: prompt
- path: instructions/my-instructions.instructions.md
kind: instruction
- path: agents/my-chatmode.agent.md
- path: agents/my-custom.agent.md
kind: agent
usage: |
recommended # or "optional" if not essential to the workflow

This chat mode requires the following instructions/prompts/MCPs:
This agent requires the following instructions/prompts/MCPs:
- Instruction 1
- Prompt 1
- MCP 1

This chat mode is ideal for...
This agent is ideal for...
- Use case 1
- Use case 2

Expand Down Expand Up @@ -255,7 +254,7 @@ We welcome many kinds of contributions, including the custom categories below:
| --- | --- | :---: |
| **Instructions** | Custom instruction sets that guide GitHub Copilot behavior | 🧭 |
| **Prompts** | Reusable or one-off prompts for GitHub Copilot | ⌨️ |
| **Agents (Chat Modes)** | Defined GitHub Copilot roles or personalities | 🎭 |
| **Agents** | Defined GitHub Copilot roles or personalities | 🎭 |
| **Skills** | Specialized knowledge of a task for GitHub Copilot | 🧰 |
| **Collections** | Curated bundles of related prompts, agents, or instructions | 🎁 |

Expand Down
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,22 @@ This repository provides a comprehensive toolkit for enhancing GitHub Copilot wi
- **👉 [Awesome Prompts](docs/README.prompts.md)** - Focused, task-specific prompts for generating code, documentation, and solving specific problems
- **👉 [Awesome Instructions](docs/README.instructions.md)** - Comprehensive coding standards and best practices that apply to specific file patterns or entire projects
- **👉 [Awesome Skills](docs/README.skills.md)** - Self-contained folders with instructions and bundled resources that enhance AI capabilities for specialized tasks
- **👉 [Awesome Collections](docs/README.collections.md)** - Curated collections of related prompts, instructions, and chat modes organized around specific themes and workflows
- **👉 [Awesome Collections](docs/README.collections.md)** - Curated collections of related prompts, instructions, agents, and skills organized around specific themes and workflows

## 🌟 Featured Collections

Discover our curated collections of prompts, instructions, and agents organized around specific themes and workflows.

| Name | Description | Items | Tags |
| ---- | ----------- | ----- | ---- |
| [Awesome Copilot](collections/awesome-copilot.md) | Meta prompts that help you discover and generate curated GitHub Copilot chat modes, collections, instructions, prompts, and agents. | 6 items | github-copilot, discovery, meta, prompt-engineering, agents |
| [Awesome Copilot](collections/awesome-copilot.md) | Meta prompts that help you discover and generate curated GitHub Copilot agents, collections, instructions, prompts, and skills. | 5 items | github-copilot, discovery, meta, prompt-engineering, agents |
| [Copilot SDK](collections/copilot-sdk.md) | Build applications with the GitHub Copilot SDK across multiple programming languages. Includes comprehensive instructions for C#, Go, Node.js/TypeScript, and Python to help you create AI-powered applications. | 4 items | copilot-sdk, sdk, csharp, go, nodejs, typescript, python, ai, github-copilot |
| [Partners](collections/partners.md) | Custom agents that have been created by GitHub partners | 20 items | devops, security, database, cloud, infrastructure, observability, feature-flags, cicd, migration, performance |


## MCP Server

To make it easy to add these customizations to your editor, we have created a [MCP Server](https://developer.microsoft.com/blog/announcing-awesome-copilot-mcp-server) that provides a prompt for searching and installing prompts, instructions, and chat modes directly from this repository. You'll need to have Docker installed and running to run the server.
To make it easy to add these customizations to your editor, we have created a [MCP Server](https://developer.microsoft.com/blog/announcing-awesome-copilot-mcp-server) that provides a prompt for searching and installing prompts, instructions, agents, and skills directly from this repository. You'll need to have Docker installed and running to run the server.

[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/mcp/vscode) [![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/mcp/vscode-insiders) [![Install in Visual Studio](https://img.shields.io/badge/Visual_Studio-Install-C16FDE?logo=visualstudio&logoColor=white)](https://aka.ms/awesome-copilot/mcp/vs)

Expand Down Expand Up @@ -82,7 +82,7 @@ Instructions automatically apply to files based on their patterns and provide co

We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details on how to:

- Add new prompts, instructions, or chat modes
- Add new prompts, instructions, agents, or skills
- Improve existing content
- Report issues or suggest enhancements

Expand Down Expand Up @@ -399,7 +399,6 @@ This project follows the [all-contributors](https://github.com/all-contributors/

- [VS Code Copilot Customization Documentation](https://code.visualstudio.com/docs/copilot/copilot-customization) - Official Microsoft documentation
- [GitHub Copilot Chat Documentation](https://code.visualstudio.com/docs/copilot/chat/copilot-chat) - Complete chat feature guide
- [Custom Chat Modes](https://code.visualstudio.com/docs/copilot/chat/chat-modes) - Advanced chat configuration
- [VS Code Settings](https://code.visualstudio.com/docs/getstarted/settings) - General VS Code configuration guide

## ™️ Trademarks
Expand Down
4 changes: 1 addition & 3 deletions collections/awesome-copilot.collection.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
id: awesome-copilot
name: Awesome Copilot
description: "Meta prompts that help you discover and generate curated GitHub Copilot chat modes, collections, instructions, prompts, and agents."
description: "Meta prompts that help you discover and generate curated GitHub Copilot agents, collections, instructions, prompts, and skills."
tags: [github-copilot, discovery, meta, prompt-engineering, agents]
items:
- path: prompts/suggest-awesome-github-copilot-chatmodes.prompt.md
kind: prompt
- path: prompts/suggest-awesome-github-copilot-collections.prompt.md
kind: prompt
- path: prompts/suggest-awesome-github-copilot-instructions.prompt.md
Expand Down
Loading
Loading