Skip to content

Commit a3988ab

Browse files
Copilotaaronpowell
andcommitted
Update documentation to remove prompts references
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
1 parent f96a900 commit a3988ab

3 files changed

Lines changed: 69 additions & 116 deletions

File tree

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'`)
@@ -120,9 +111,9 @@ All agent files (`*.agent.md`), prompt files (`*.prompt.md`), and instruction fi
120111

121112
### Adding New Resources
122113

123-
When adding a new agent, prompt, instruction, skill, hook, workflow, or plugin:
114+
When adding a new agent, instruction, skill, hook, workflow, or plugin:
124115

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

213204
### Pre-commit Checklist
@@ -222,13 +213,6 @@ Before submitting your PR, ensure you have:
222213

223214
### Code Review Checklist
224215

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

296280
## MCP Server
297281

298-
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.
282+
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.
299283

300284
## License
301285

CONTRIBUTING.md

Lines changed: 9 additions & 34 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
## How to Contribute
66

@@ -33,34 +33,6 @@ description: 'Instructions for customizing GitHub Copilot behavior for specific
3333
- Any additional context or examples
3434
```
3535

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-
6436
### Adding an Agent
6537

6638
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
11385

11486
### Adding Plugins
11587

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

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

216188
1. **Fork this repository**
217189
2. **Create a new branch** for your contribution
218-
3. **Add your instruction, prompt file, chatmode, workflow, or plugin** following the guidelines above
190+
3. **Add your instruction, skills, agents, workflow, or plugin** following the guidelines above
219191
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)
220192
- A GitHub Actions workflow will verify that this step was performed correctly
221193
- If the README.md would be modified by running the script, the PR check will fail with a comment showing the required changes
222194
5. **Submit a pull request** targeting the `staged` branch with:
223195
- A clear title describing your contribution
224-
- A brief description of what your instruction/prompt does
196+
- A brief description of what your instruction/skill/agent does
225197
- Any relevant context or usage notes
226198

227199
> [!IMPORTANT]
@@ -256,7 +228,7 @@ To maintain a safe, responsible, and constructive community, we will **not accep
256228
## Quality Guidelines
257229

258230
- **Be specific**: Generic instructions are less helpful than specific, actionable guidance
259-
- **Test your content**: Ensure your instructions or prompts work well with GitHub Copilot
231+
- **Test your content**: Ensure your instructions or skills work well with GitHub Copilot
260232
- **Follow conventions**: Use consistent formatting and naming
261233
- **Keep it focused**: Each file should address a specific technology, framework, or use case
262234
- **Write clearly**: Use simple, direct language
@@ -281,11 +253,14 @@ We welcome many kinds of contributions, including the custom categories below:
281253
| Category | Description | Emoji |
282254
| --- | --- | :---: |
283255
| **Instructions** | Custom instruction sets that guide GitHub Copilot behavior | 🧭 |
284-
| **Prompts** | Reusable or one-off prompts for GitHub Copilot | ⌨️ |
285256
| **Agents** | Defined GitHub Copilot roles or personalities | 🎭 |
286257
| **Skills** | Specialized knowledge of a task for GitHub Copilot | 🧰 |
258+
<<<<<<< HEAD
287259
| **Workflows** | Agentic Workflows for AI-powered repository automation ||
288260
| **Plugins** | Installable packages of related prompts, agents, or skills | 🎁 |
261+
=======
262+
| **Plugins** | Installable packages of related agents, commands, or skills | 🎁 |
263+
>>>>>>> 9e10967 (Update documentation to remove prompts references)
289264
290265
In addition, all standard contribution types supported by [All Contributors](https://allcontributors.org/emoji-key/) are recognized.
291266

0 commit comments

Comments
 (0)