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: AGENTS.md
+7-23Lines changed: 7 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,10 +2,9 @@
2
2
3
3
## Project Overview
4
4
5
-
The Awesome GitHub Copilot repository is a community-driven collection of custom agents, prompts, and instructions designed to enhance GitHub Copilot experiences across various domains, languages, and use cases. The project includes:
5
+
The Awesome GitHub Copilot repository is a community-driven collection of custom agents and instructions designed to enhance GitHub Copilot experiences across various domains, languages, and use cases. The project includes:
6
6
7
7
-**Agents** - Specialized GitHub Copilot agents that integrate with MCP servers
8
-
-**Prompts** - Task-specific prompts for code generation and problem-solving
9
8
-**Instructions** - Coding standards and best practices applied to specific file patterns
10
9
-**Skills** - Self-contained folders with instructions and bundled resources for specialized tasks
11
10
-**Hooks** - Automated workflows triggered by specific events during development
@@ -16,7 +15,6 @@ The Awesome GitHub Copilot repository is a community-driven collection of custom
@@ -53,23 +51,16 @@ npm run skill:create -- --name <skill-name>
53
51
54
52
## Development Workflow
55
53
56
-
### Working with Agents, Prompts, Instructions, Skills, and Hooks
54
+
### Working with Agents, Instructions, Skills, and Hooks
57
55
58
-
All agent files (`*.agent.md`), prompt files (`*.prompt.md`), and instruction files (`*.instructions.md`) must include proper markdown front matter. Agent Skills are folders containing a `SKILL.md` file with frontmatter and optional bundled assets. Hooks are folders containing a `README.md` with frontmatter and a `hooks.json` configuration file:
56
+
All agent files (`*.agent.md`) and instruction files (`*.instructions.md`) must include proper markdown front matter. Agent Skills are folders containing a `SKILL.md` file with frontmatter and optional bundled assets. Hooks are folders containing a `README.md` with frontmatter and a `hooks.json` configuration file:
59
57
60
58
#### Agent Files (*.agent.md)
61
59
- Must have `description` field (wrapped in single quotes)
62
60
- File names should be lower case with words separated by hyphens
63
61
- Recommended to include `tools` field
64
62
- Strongly recommended to specify `model` field
65
63
66
-
#### Prompt Files (*.prompt.md)
67
-
- Must have `agent` field (value should be `'agent'` wrapped in single quotes)
68
-
- Must have `description` field (wrapped in single quotes, not empty)
69
-
- File names should be lower case with words separated by hyphens
70
-
- Recommended to specify `tools` if applicable
71
-
- Strongly recommended to specify `model` field
72
-
73
64
#### Instruction Files (*.instructions.md)
74
65
- Must have `description` field (wrapped in single quotes, not empty)
75
66
- Must have `applyTo` field specifying file patterns (e.g., `'**.js, **.ts'`)
@@ -107,9 +98,9 @@ All agent files (`*.agent.md`), prompt files (`*.prompt.md`), and instruction fi
107
98
108
99
### Adding New Resources
109
100
110
-
When adding a new agent, prompt, instruction, skill, hook, or plugin:
101
+
When adding a new agent, instruction, skill, hook, or plugin:
111
102
112
-
**For Agents, Prompts, and Instructions:**
103
+
**For Agents and Instructions:**
113
104
1. Create the file with proper front matter
114
105
2. Add the file to the appropriate directory
115
106
3. Update the README.md by running: `npm run build`
@@ -186,7 +177,7 @@ When creating a pull request:
186
177
3.**File naming**: Verify all new files follow the lower-case-with-hyphens naming convention
187
178
4.**Build check**: Run `npm run build` before committing to verify README generation
188
179
5.**Line endings**: **Always run `bash scripts/fix-line-endings.sh`** to normalize line endings to LF (Unix-style)
189
-
6.**Description**: Provide a clear description of what your agent/prompt/instruction does
180
+
6.**Description**: Provide a clear description of what your agent/instruction does
190
181
7.**Testing**: If adding a plugin, run `npm run plugin:validate` to ensure validity
191
182
192
183
### Pre-commit Checklist
@@ -201,13 +192,6 @@ Before submitting your PR, ensure you have:
201
192
202
193
### Code Review Checklist
203
194
204
-
For prompt files (*.prompt.md):
205
-
-[ ] Has markdown front matter
206
-
-[ ] Has `agent` field (value should be `'agent'` wrapped in single quotes)
207
-
-[ ] Has non-empty `description` field wrapped in single quotes
208
-
-[ ] File name is lower case with hyphens
209
-
-[ ] Includes `model` field (strongly recommended)
210
-
211
195
For instruction files (*.instructions.md):
212
196
-[ ] Has markdown front matter
213
197
-[ ] Has non-empty `description` field wrapped in single quotes
@@ -262,7 +246,7 @@ This is a community-driven project. Contributions are welcome! Please see:
262
246
263
247
## MCP Server
264
248
265
-
The repository includes an MCP (Model Context Protocol) Server that provides prompts for searching and installing resources directly from this repository. Docker is required to run the server.
249
+
The repository includes an MCP (Model Context Protocol) Server for searching and installing resources directly from this repository. Docker is required to run the server.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-35Lines changed: 6 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Contributing to Awesome GitHub Copilot
2
2
3
-
Thank you for your interest in contributing to the Awesome GitHub Copilot repository! We welcome contributions from the community to help expand our collection of custom instructions and prompts.
3
+
Thank you for your interest in contributing to the Awesome GitHub Copilot repository! We welcome contributions from the community to help expand our collection of custom instructions and skills.
4
4
5
5
## How to Contribute
6
6
@@ -33,34 +33,6 @@ description: 'Instructions for customizing GitHub Copilot behavior for specific
33
33
- Any additional context or examples
34
34
```
35
35
36
-
### Adding Prompts
37
-
38
-
Prompts are ready-to-use templates for specific development scenarios and tasks.
39
-
40
-
1.**Create your prompt file**: Add a new `.prompt.md` file in the `prompts/` directory
41
-
2.**Follow the naming convention**: Use descriptive, lowercase filenames with hyphens and the `.prompt.md` extension (e.g., `react-component-generator.prompt.md`)
42
-
3.**Include frontmatter**: Add metadata at the top of your file (optional but recommended)
43
-
4.**Structure your prompt**: Provide clear context and specific instructions
44
-
45
-
#### Example prompt format
46
-
47
-
```markdown
48
-
---
49
-
agent: 'agent'
50
-
tools: ['codebase', 'terminalCommand']
51
-
description: 'Brief description of what this prompt does'
52
-
---
53
-
54
-
# Prompt Title
55
-
56
-
Your goal is to...
57
-
58
-
## Specific Instructions
59
-
60
-
- Clear, actionable instructions
61
-
- Include examples where helpful
62
-
```
63
-
64
36
### Adding an Agent
65
37
66
38
Agents are specialized configurations that transform GitHub Copilot Chat into domain-specific assistants or personas for particular development scenarios.
@@ -113,7 +85,7 @@ Skills are self-contained folders in the `skills/` directory that include a `SKI
113
85
114
86
### Adding Plugins
115
87
116
-
Plugins group related agents, commands (prompts), and skills around specific themes or workflows, making it easy for users to install comprehensive toolkits via GitHub Copilot CLI.
88
+
Plugins group related agents, commands, and skills around specific themes or workflows, making it easy for users to install comprehensive toolkits via GitHub Copilot CLI.
117
89
118
90
1.**Create your plugin**: Run `npm run plugin:create` to scaffold a new plugin
119
91
2.**Follow the naming convention**: Use descriptive, lowercase folder names with hyphens (e.g., `python-web-development`)
@@ -165,13 +137,13 @@ plugins/my-plugin-id/
165
137
166
138
1.**Fork this repository**
167
139
2.**Create a new branch** for your contribution
168
-
3.**Add your instruction, prompt file, chatmode, or plugin** following the guidelines above
140
+
3.**Add your instruction, skill, agent, or plugin** following the guidelines above
169
141
4.**Run the update script**: `npm start` to update the README with your new file (make sure you run `npm install` first if you haven't already)
170
142
- A GitHub Actions workflow will verify that this step was performed correctly
171
143
- If the README.md would be modified by running the script, the PR check will fail with a comment showing the required changes
172
144
5.**Submit a pull request** targeting the `staged` branch with:
173
145
- A clear title describing your contribution
174
-
- A brief description of what your instruction/prompt does
146
+
- A brief description of what your instruction/skill/agent does
175
147
- Any relevant context or usage notes
176
148
177
149
> [!IMPORTANT]
@@ -206,7 +178,7 @@ To maintain a safe, responsible, and constructive community, we will **not accep
206
178
## Quality Guidelines
207
179
208
180
-**Be specific**: Generic instructions are less helpful than specific, actionable guidance
209
-
-**Test your content**: Ensure your instructions or prompts work well with GitHub Copilot
181
+
-**Test your content**: Ensure your instructions or skills work well with GitHub Copilot
210
182
-**Follow conventions**: Use consistent formatting and naming
211
183
-**Keep it focused**: Each file should address a specific technology, framework, or use case
212
184
-**Write clearly**: Use simple, direct language
@@ -231,10 +203,9 @@ We welcome many kinds of contributions, including the custom categories below:
0 commit comments