Awesome/awesome-copilot
1
0
Fork 0
mirror of https://github.com/github/awesome-copilot.git synced 2026-02-20 02:15:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Cleaning up some legacy around chat modes

Browse Source
This commit is contained in:
Aaron Powell
2026-01-23 10:51:55 +11:00
parent 888fbe6c95
commit 92dbe54cc6
11 changed files with 54 additions and 120 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
.github/copilot-instructions.md vendored
View File

@@ -2,20 +2,20 @@ The following instructions are only to be applied when performing a code review.
## README updates
- [ ] The new file should be added to the `README.md`.
- [ ] The new file should be added to the `docs/README.<type>.md`.
## Prompt file guide
**Only apply to files that end in `.prompt.md`**
- [ ] The prompt has markdown front matter.
- [ ] The prompt has a `mode` field specified of either `agent` or `ask`.
- [ ] The prompt has a `agent` field specified of either `agent`, `ask`, or `Plan`.
- [ ] The prompt has a `description` field.
- [ ] The `description` field is not empty.
- [ ] The `description` field value is wrapped in single quotes.
- [ ] The file name is lower case, with words separated by hyphens.
- [ ] Encourage the use of `tools`, but it's not required.
- [ ] Strongly encourage the use of `model` to specify the model that the prompt is optimised for.
- [ ] Strongly encourage the use of `name` to set the name for the prompt.
## Instruction file guide
@@ -24,21 +24,20 @@ The following instructions are only to be applied when performing a code review.
- [ ] The instruction has markdown front matter.
- [ ] The instruction has a `description` field.
- [ ] The `description` field is not empty.
- [ ] The `description` field value is wrapped in single quotes.
- [ ] The file name is lower case, with words separated by hyphens.
- [ ] 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'`.
## Chat Mode file guide
## Agent file guide
**Only apply to files that end in `.agent.md`**
- [ ] The chat mode has markdown front matter.
- [ ] The chat mode has a `description` field.
- [ ] The agent has markdown front matter.
- [ ] The agent has a `description` field.
- [ ] The `description` field is not empty.
- [ ] The `description` field value is wrapped in single quotes.
- [ ] The file name is lower case, with words separated by hyphens.
- [ ] Encourage the use of `tools`, but it's not required.
- [ ] Strongly encourage the use of `model` to specify the model that the chat mode is optimised for.
- [ ] Strongly encourage the use of `model` to specify the model that the agent is optimised for.
- [ ] Strongly encourage the use of `name` to set the name for the agent.
## Agent Skills guide
@@ -55,3 +54,19 @@ The following instructions are only to be applied when performing a code review.
- [ ] The folder name is lower case, with words separated by hyphens.
- [ ] Any bundled assets (scripts, templates, data files) are referenced in the SKILL.md instructions.
- [ ] Bundled assets are reasonably sized (under 5MB per file).
## Collection file guide
**Only apply to files that end in `.collection.yml`**
- [ ] The collection has a `name` field.
- [ ] The collection has a `description` field.
- [ ] The `description` field is not empty.
- [ ] The collection has a `tags` field.
- [ ] The file name is lower case, with words separated by hyphens.
- [ ] Each item in the collection has a `path` field.
- [ ] Each item in the collection has a `kind` field.
- [ ] The `kind` field value is one of: `prompt`, `instruction`, `agent`, or `skill`.
- [ ] The collection does not include duplicate items.
- [ ] The collection does not reference non-existent files.
- [ ] Each item can have an optional `usage` field describing when to use the item.

8
.github/pull_request_template.md vendored
View File

@@ -1,10 +1,10 @@
## Pull Request Checklist
- [ ] I have read and followed the [CONTRIBUTING.md](https://github.com/github/awesome-copilot/blob/main/CONTRIBUTING.md) guidelines.
- [ ] My contribution adds a new instruction, prompt, or chat mode file in the correct directory.
- [ ] My contribution adds a new instruction, prompt, agent, or skill file in the correct directory.
- [ ] The file follows the required naming convention.
- [ ] The content is clearly structured and follows the example format.
- [ ] I have tested my instructions, prompt, or chat mode with GitHub Copilot.
- [ ] I have tested my instructions, prompt, agent, or skill with GitHub Copilot.
- [ ] I have run `npm start` and verified that `README.md` is up to date.
---
@@ -19,10 +19,10 @@
- [ ] New instruction file.
- [ ] New prompt file.
- [ ] New chat mode file.
- [ ] New agent file.
- [ ] New collection file.
- [ ] New skill file.
- [ ] Update to existing instruction, prompt, chat mode, collection or skill.
- [ ] Update to existing instruction, prompt, agent, collection or skill.
- [ ] Other (please specify):
---