Skip to content

Commit 92dbe54

Browse files
committed
Cleaning up some legacy around chat modes
1 parent 888fbe6 commit 92dbe54

11 files changed

+54
-120
lines changed

.github/copilot-instructions.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@ The following instructions are only to be applied when performing a code review.
22

33
## README updates
44

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

77
## Prompt file guide
88

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

1111
- [ ] The prompt has markdown front matter.
12-
- [ ] The prompt has a `mode` field specified of either `agent` or `ask`.
12+
- [ ] The prompt has a `agent` field specified of either `agent`, `ask`, or `Plan`.
1313
- [ ] The prompt has a `description` field.
1414
- [ ] The `description` field is not empty.
15-
- [ ] The `description` field value is wrapped in single quotes.
1615
- [ ] The file name is lower case, with words separated by hyphens.
1716
- [ ] Encourage the use of `tools`, but it's not required.
1817
- [ ] Strongly encourage the use of `model` to specify the model that the prompt is optimised for.
18+
- [ ] Strongly encourage the use of `name` to set the name for the prompt.
1919

2020
## Instruction file guide
2121

@@ -24,21 +24,20 @@ The following instructions are only to be applied when performing a code review.
2424
- [ ] The instruction has markdown front matter.
2525
- [ ] The instruction has a `description` field.
2626
- [ ] The `description` field is not empty.
27-
- [ ] The `description` field value is wrapped in single quotes.
2827
- [ ] The file name is lower case, with words separated by hyphens.
2928
- [ ] 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'`.
3029

31-
## Chat Mode file guide
30+
## Agent file guide
3231

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

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

4342
## Agent Skills guide
4443

@@ -55,3 +54,19 @@ The following instructions are only to be applied when performing a code review.
5554
- [ ] The folder name is lower case, with words separated by hyphens.
5655
- [ ] Any bundled assets (scripts, templates, data files) are referenced in the SKILL.md instructions.
5756
- [ ] Bundled assets are reasonably sized (under 5MB per file).
57+
58+
## Collection file guide
59+
60+
**Only apply to files that end in `.collection.yml`**
61+
62+
- [ ] The collection has a `name` field.
63+
- [ ] The collection has a `description` field.
64+
- [ ] The `description` field is not empty.
65+
- [ ] The collection has a `tags` field.
66+
- [ ] The file name is lower case, with words separated by hyphens.
67+
- [ ] Each item in the collection has a `path` field.
68+
- [ ] Each item in the collection has a `kind` field.
69+
- [ ] The `kind` field value is one of: `prompt`, `instruction`, `agent`, or `skill`.
70+
- [ ] The collection does not include duplicate items.
71+
- [ ] The collection does not reference non-existent files.
72+
- [ ] Each item can have an optional `usage` field describing when to use the item.

.github/pull_request_template.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## Pull Request Checklist
22

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

1010
---
@@ -19,10 +19,10 @@
1919

2020
- [ ] New instruction file.
2121
- [ ] New prompt file.
22-
- [ ] New chat mode file.
22+
- [ ] New agent file.
2323
- [ ] New collection file.
2424
- [ ] New skill file.
25-
- [ ] Update to existing instruction, prompt, chat mode, collection or skill.
25+
- [ ] Update to existing instruction, prompt, agent, collection or skill.
2626
- [ ] Other (please specify):
2727

2828
---

CONTRIBUTING.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -61,27 +61,26 @@ Your goal is to...
6161
- Include examples where helpful
6262
```
6363

64-
### Adding Chat Modes
64+
### Adding an Agent
6565

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

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

74-
#### Example chat mode format
74+
#### Example agent format
7575

7676
```markdown
7777
---
78-
description: 'Brief description of the chat mode and its purpose'
78+
description: 'Brief description of the agent and its purpose'
7979
model: 'gpt-5'
8080
tools: ['codebase', 'terminalCommand']
81+
name: 'My Agent Name'
8182
---
8283

83-
# Chat Mode Title
84-
8584
You are an expert [domain/role] with deep knowledge in [specific areas].
8685

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

115114
### Adding Collections
116115

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

119118
1. **Create your collection manifest**: Add a new `.collection.yml` file in the `collections/` directory
120119
2. **Follow the naming convention**: Use descriptive, lowercase filenames with hyphens (e.g., `python-web-development.collection.yml`)
@@ -142,17 +141,17 @@ items:
142141
kind: prompt
143142
- path: instructions/my-instructions.instructions.md
144143
kind: instruction
145-
- path: agents/my-chatmode.agent.md
144+
- path: agents/my-custom.agent.md
146145
kind: agent
147146
usage: |
148147
recommended # or "optional" if not essential to the workflow
149148
150-
This chat mode requires the following instructions/prompts/MCPs:
149+
This agent requires the following instructions/prompts/MCPs:
151150
- Instruction 1
152151
- Prompt 1
153152
- MCP 1
154153
155-
This chat mode is ideal for...
154+
This agent is ideal for...
156155
- Use case 1
157156
- Use case 2
158157
@@ -255,7 +254,7 @@ We welcome many kinds of contributions, including the custom categories below:
255254
| --- | --- | :---: |
256255
| **Instructions** | Custom instruction sets that guide GitHub Copilot behavior | 🧭 |
257256
| **Prompts** | Reusable or one-off prompts for GitHub Copilot | ⌨️ |
258-
| **Agents (Chat Modes)** | Defined GitHub Copilot roles or personalities | 🎭 |
257+
| **Agents** | Defined GitHub Copilot roles or personalities | 🎭 |
259258
| **Skills** | Specialized knowledge of a task for GitHub Copilot | 🧰 |
260259
| **Collections** | Curated bundles of related prompts, agents, or instructions | 🎁 |
261260

README.md

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

1717
## 🌟 Featured Collections
1818

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

2121
| Name | Description | Items | Tags |
2222
| ---- | ----------- | ----- | ---- |
23-
| [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 |
23+
| [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 |
2424
| [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 |
2525
| [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 |
2626

2727

2828
## MCP Server
2929

30-
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.
30+
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.
3131

3232
[![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)
3333

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

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

85-
- Add new prompts, instructions, or chat modes
85+
- Add new prompts, instructions, agents, or skills
8686
- Improve existing content
8787
- Report issues or suggest enhancements
8888

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

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

405404
## ™️ Trademarks

collections/awesome-copilot.collection.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
id: awesome-copilot
22
name: Awesome Copilot
3-
description: "Meta prompts that help you discover and generate curated GitHub Copilot chat modes, collections, instructions, prompts, and agents."
3+
description: "Meta prompts that help you discover and generate curated GitHub Copilot agents, collections, instructions, prompts, and skills."
44
tags: [github-copilot, discovery, meta, prompt-engineering, agents]
55
items:
6-
- path: prompts/suggest-awesome-github-copilot-chatmodes.prompt.md
7-
kind: prompt
86
- path: prompts/suggest-awesome-github-copilot-collections.prompt.md
97
kind: prompt
108
- path: prompts/suggest-awesome-github-copilot-instructions.prompt.md

0 commit comments

Comments
 (0)