mirror of
https://github.com/github/awesome-copilot.git
synced 2026-02-20 18:35:14 +00:00
58 lines
2.5 KiB
Markdown
58 lines
2.5 KiB
Markdown
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`.
|
|
|
|
## 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 `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.
|
|
|
|
## Instruction file guide
|
|
|
|
**Only apply to files that end in `.instructions.md`**
|
|
|
|
- [ ] 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
|
|
|
|
**Only apply to files that end in `.agent.md`**
|
|
|
|
- [ ] The chat mode has markdown front matter.
|
|
- [ ] The chat mode 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.
|
|
|
|
## Agent Skills guide
|
|
|
|
**Only apply to folders in the `skills/` directory**
|
|
|
|
- [ ] The skill folder contains a `SKILL.md` file.
|
|
- [ ] The SKILL.md has markdown front matter.
|
|
- [ ] The SKILL.md has a `name` field.
|
|
- [ ] The `name` field value is lowercase with words separated by hyphens.
|
|
- [ ] The `name` field matches the folder name.
|
|
- [ ] The SKILL.md has a `description` field.
|
|
- [ ] The `description` field is not empty, at least 10 characters, and maximum 1024 characters.
|
|
- [ ] The `description` field value is wrapped in single quotes.
|
|
- [ ] 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).
|