Skip to content

Commit 2cb6bde

Browse files
authored
Merge pull request #761 from github/copilot/combine-prompts-and-skills
Migrate prompts to skills - consolidate to single task customization model
2 parents 278789c + d144ab6 commit 2cb6bde

194 files changed

Lines changed: 911 additions & 932 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

AGENTS.md

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22

33
## Project Overview
44

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:
66

77
- **Agents** - Specialized GitHub Copilot agents that integrate with MCP servers
8-
- **Prompts** - Task-specific prompts for code generation and problem-solving
98
- **Instructions** - Coding standards and best practices applied to specific file patterns
109
- **Skills** - Self-contained folders with instructions and bundled resources for specialized tasks
1110
- **Hooks** - Automated workflows triggered by specific events during development
@@ -17,7 +16,6 @@ The Awesome GitHub Copilot repository is a community-driven collection of custom
1716
```
1817
.
1918
├── agents/ # Custom GitHub Copilot agent definitions (.agent.md files)
20-
├── prompts/ # Task-specific prompts (.prompt.md files)
2119
├── instructions/ # Coding standards and guidelines (.instructions.md files)
2220
├── skills/ # Agent Skills folders (each with SKILL.md and optional bundled assets)
2321
├── hooks/ # Automated workflow hooks (folders with README.md + hooks.json)
@@ -55,23 +53,16 @@ npm run skill:create -- --name <skill-name>
5553

5654
## Development Workflow
5755

58-
### Working with Agents, Prompts, Instructions, Skills, and Hooks
56+
### Working with Agents, Instructions, Skills, and Hooks
5957

60-
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:
58+
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:
6159

6260
#### Agent Files (*.agent.md)
6361
- Must have `description` field (wrapped in single quotes)
6462
- File names should be lower case with words separated by hyphens
6563
- Recommended to include `tools` field
6664
- Strongly recommended to specify `model` field
6765

68-
#### Prompt Files (*.prompt.md)
69-
- Must have `agent` field (value should be `'agent'` wrapped in single quotes)
70-
- Must have `description` field (wrapped in single quotes, not empty)
71-
- File names should be lower case with words separated by hyphens
72-
- Recommended to specify `tools` if applicable
73-
- Strongly recommended to specify `model` field
74-
7566
#### Instruction Files (*.instructions.md)
7667
- Must have `description` field (wrapped in single quotes, not empty)
7768
- Must have `applyTo` field specifying file patterns (e.g., `'**.js, **.ts'`)
@@ -118,9 +109,9 @@ All agent files (`*.agent.md`), prompt files (`*.prompt.md`), and instruction fi
118109

119110
### Adding New Resources
120111

121-
When adding a new agent, prompt, instruction, skill, hook, workflow, or plugin:
112+
When adding a new agent, instruction, skill, hook, workflow, or plugin:
122113

123-
**For Agents, Prompts, and Instructions:**
114+
**For Agents and Instructions:**
124115
1. Create the file with proper front matter
125116
2. Add the file to the appropriate directory
126117
3. Update the README.md by running: `npm run build`
@@ -205,7 +196,7 @@ When creating a pull request:
205196
3. **File naming**: Verify all new files follow the lower-case-with-hyphens naming convention
206197
4. **Build check**: Run `npm run build` before committing to verify README generation
207198
5. **Line endings**: **Always run `bash scripts/fix-line-endings.sh`** to normalize line endings to LF (Unix-style)
208-
6. **Description**: Provide a clear description of what your agent/prompt/instruction does
199+
6. **Description**: Provide a clear description of what your agent/instruction does
209200
7. **Testing**: If adding a plugin, run `npm run plugin:validate` to ensure validity
210201

211202
### Pre-commit Checklist
@@ -220,13 +211,6 @@ Before submitting your PR, ensure you have:
220211

221212
### Code Review Checklist
222213

223-
For prompt files (*.prompt.md):
224-
- [ ] Has markdown front matter
225-
- [ ] Has `agent` field (value should be `'agent'` wrapped in single quotes)
226-
- [ ] Has non-empty `description` field wrapped in single quotes
227-
- [ ] File name is lower case with hyphens
228-
- [ ] Includes `model` field (strongly recommended)
229-
230214
For instruction files (*.instructions.md):
231215
- [ ] Has markdown front matter
232216
- [ ] Has non-empty `description` field wrapped in single quotes
@@ -291,7 +275,7 @@ This is a community-driven project. Contributions are welcome! Please see:
291275

292276
## MCP Server
293277

294-
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.
278+
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.
295279

296280
## License
297281

CONTRIBUTING.md

Lines changed: 6 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing to Awesome GitHub Copilot
22

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.
44

55
## Table of Contents
66

@@ -52,35 +52,7 @@ description: 'Instructions for customizing GitHub Copilot behavior for specific
5252
- Any additional context or examples
5353
```
5454

55-
### Adding Prompts
56-
57-
Prompts are ready-to-use templates for specific development scenarios and tasks.
58-
59-
1. **Create your prompt file**: Add a new `.prompt.md` file in the `prompts/` directory
60-
2. **Follow the naming convention**: Use descriptive, lowercase filenames with hyphens and the `.prompt.md` extension (e.g., `react-component-generator.prompt.md`)
61-
3. **Include frontmatter**: Add metadata at the top of your file (optional but recommended)
62-
4. **Structure your prompt**: Provide clear context and specific instructions
63-
64-
#### Example prompt format
65-
66-
```markdown
67-
---
68-
agent: 'agent'
69-
tools: ['codebase', 'terminalCommand']
70-
description: 'Brief description of what this prompt does'
71-
---
72-
73-
# Prompt Title
74-
75-
Your goal is to...
76-
77-
## Specific Instructions
78-
79-
- Clear, actionable instructions
80-
- Include examples where helpful
81-
```
82-
83-
### Adding Agents
55+
### Adding an Agent
8456

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

@@ -132,7 +104,7 @@ Skills are self-contained folders in the `skills/` directory that include a `SKI
132104

133105
### Adding Plugins
134106

135-
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.
107+
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.
136108

137109
1. **Create your plugin**: Run `npm run plugin:create` to scaffold a new plugin
138110
2. **Follow the naming convention**: Use descriptive, lowercase folder names with hyphens (e.g., `python-web-development`)
@@ -273,13 +245,13 @@ Create a daily summary of open issues for the team.
273245

274246
1. **Fork this repository**
275247
2. **Create a new branch** for your contribution
276-
3. **Add your instruction, prompt file, chatmode, workflow, or plugin** following the guidelines above
248+
3. **Add your instruction, skills, agents, workflow, or plugin** following the guidelines above
277249
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)
278250
- A GitHub Actions workflow will verify that this step was performed correctly
279251
- If the README.md would be modified by running the script, the PR check will fail with a comment showing the required changes
280252
5. **Submit a pull request** targeting the `staged` branch with:
281253
- A clear title describing your contribution
282-
- A brief description of what your instruction/prompt does
254+
- A brief description of what your instruction/skill/agent does
283255
- Any relevant context or usage notes
284256

285257
> [!IMPORTANT]
@@ -314,7 +286,7 @@ To maintain a safe, responsible, and constructive community, we will **not accep
314286
## Quality Guidelines
315287

316288
- **Be specific**: Generic instructions are less helpful than specific, actionable guidance
317-
- **Test your content**: Ensure your instructions or prompts work well with GitHub Copilot
289+
- **Test your content**: Ensure your instructions or skills work well with GitHub Copilot
318290
- **Follow conventions**: Use consistent formatting and naming
319291
- **Keep it focused**: Each file should address a specific technology, framework, or use case
320292
- **Write clearly**: Use simple, direct language
@@ -339,7 +311,6 @@ We welcome many kinds of contributions, including the custom categories below:
339311
| Category | Description | Emoji |
340312
| --- | --- | :---: |
341313
| **Instructions** | Custom instruction sets that guide GitHub Copilot behavior | 🧭 |
342-
| **Prompts** | Reusable or one-off prompts for GitHub Copilot | ⌨️ |
343314
| **Agents** | Defined GitHub Copilot roles or personalities | 🎭 |
344315
| **Skills** | Specialized knowledge of a task for GitHub Copilot | 🧰 |
345316
| **Workflows** | Agentic Workflows for AI-powered repository automation ||

0 commit comments

Comments
 (0)