You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/copilot-instructions.md
+24-9Lines changed: 24 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,20 +2,20 @@ The following instructions are only to be applied when performing a code review.
2
2
3
3
## README updates
4
4
5
-
-[ ] The new file should be added to the `README.md`.
5
+
-[ ] The new file should be added to the `docs/README.<type>.md`.
6
6
7
7
## Prompt file guide
8
8
9
9
**Only apply to files that end in `.prompt.md`**
10
10
11
11
-[ ] 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`.
13
13
-[ ] The prompt has a `description` field.
14
14
-[ ] The `description` field is not empty.
15
-
-[ ] The `description` field value is wrapped in single quotes.
16
15
-[ ] The file name is lower case, with words separated by hyphens.
17
16
-[ ] Encourage the use of `tools`, but it's not required.
18
17
-[ ] 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.
19
19
20
20
## Instruction file guide
21
21
@@ -24,21 +24,20 @@ The following instructions are only to be applied when performing a code review.
24
24
-[ ] The instruction has markdown front matter.
25
25
-[ ] The instruction has a `description` field.
26
26
-[ ] The `description` field is not empty.
27
-
-[ ] The `description` field value is wrapped in single quotes.
28
27
-[ ] The file name is lower case, with words separated by hyphens.
29
28
-[ ] 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'`.
30
29
31
-
## Chat Mode file guide
30
+
## Agent file guide
32
31
33
32
**Only apply to files that end in `.agent.md`**
34
33
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.
37
36
-[ ] The `description` field is not empty.
38
-
-[ ] The `description` field value is wrapped in single quotes.
39
37
-[ ] The file name is lower case, with words separated by hyphens.
40
38
-[ ] 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.
42
41
43
42
## Agent Skills guide
44
43
@@ -55,3 +54,19 @@ The following instructions are only to be applied when performing a code review.
55
54
-[ ] The folder name is lower case, with words separated by hyphens.
56
55
-[ ] Any bundled assets (scripts, templates, data files) are referenced in the SKILL.md instructions.
57
56
-[ ] 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.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+13-14Lines changed: 13 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,27 +61,26 @@ Your goal is to...
61
61
- Include examples where helpful
62
62
```
63
63
64
-
### Adding Chat Modes
64
+
### Adding an Agent
65
65
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.
67
67
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
69
69
2.**Follow the naming convention**: Use descriptive, lowercase filenames with hyphens and the `.agent.md` extension (e.g., `react-performance-expert.agent.md`)
70
70
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
73
73
74
-
#### Example chat mode format
74
+
#### Example agent format
75
75
76
76
```markdown
77
77
---
78
-
description: 'Brief description of the chat mode and its purpose'
78
+
description: 'Brief description of the agent and its purpose'
79
79
model: 'gpt-5'
80
80
tools: ['codebase', 'terminalCommand']
81
+
name: 'My Agent Name'
81
82
---
82
83
83
-
# Chat Mode Title
84
-
85
84
You are an expert [domain/role] with deep knowledge in [specific areas].
86
85
87
86
## Your Expertise
@@ -114,7 +113,7 @@ Skills are self-contained folders in the `skills/` directory that include a `SKI
114
113
115
114
### Adding Collections
116
115
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.
118
117
119
118
1.**Create your collection manifest**: Add a new `.collection.yml` file in the `collections/` directory
120
119
2.**Follow the naming convention**: Use descriptive, lowercase filenames with hyphens (e.g., `python-web-development.collection.yml`)
Copy file name to clipboardExpand all lines: README.md
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,22 +12,22 @@ This repository provides a comprehensive toolkit for enhancing GitHub Copilot wi
12
12
-**👉 [Awesome Prompts](docs/README.prompts.md)** - Focused, task-specific prompts for generating code, documentation, and solving specific problems
13
13
-**👉 [Awesome Instructions](docs/README.instructions.md)** - Comprehensive coding standards and best practices that apply to specific file patterns or entire projects
14
14
-**👉 [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
16
16
17
17
## 🌟 Featured Collections
18
18
19
19
Discover our curated collections of prompts, instructions, and agents organized around specific themes and workflows.
20
20
21
21
| Name | Description | Items | Tags |
22
22
| ---- | ----------- | ----- | ---- |
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 |
24
24
|[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 |
25
25
|[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 |
26
26
27
27
28
28
## MCP Server
29
29
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.
31
31
32
32
[](https://aka.ms/awesome-copilot/mcp/vscode)[](https://aka.ms/awesome-copilot/mcp/vscode-insiders)[](https://aka.ms/awesome-copilot/mcp/vs)
33
33
@@ -82,7 +82,7 @@ Instructions automatically apply to files based on their patterns and provide co
82
82
83
83
We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details on how to:
84
84
85
-
- Add new prompts, instructions, or chat modes
85
+
- Add new prompts, instructions, agents, or skills
86
86
- Improve existing content
87
87
- Report issues or suggest enhancements
88
88
@@ -399,7 +399,6 @@ This project follows the [all-contributors](https://github.com/all-contributors/
399
399
400
400
-[VS Code Copilot Customization Documentation](https://code.visualstudio.com/docs/copilot/copilot-customization) - Official Microsoft documentation
0 commit comments