mirror of
https://github.com/github/awesome-copilot.git
synced 2026-02-20 10:25:13 +00:00
73 lines
3.2 KiB
Markdown
73 lines
3.2 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 `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 `agent` field specified of either `agent`, `ask`, or `Plan`.
|
|
- [ ] The prompt has a `description` field.
|
|
- [ ] The `description` field is not empty.
|
|
- [ ] 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
|
|
|
|
**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 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'`.
|
|
|
|
## Agent file guide
|
|
|
|
**Only apply to files that end in `.agent.md`**
|
|
|
|
- [ ] The agent has markdown front matter.
|
|
- [ ] The agent has a `description` field.
|
|
- [ ] The `description` field is not empty.
|
|
- [ ] 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 agent is optimised for.
|
|
- [ ] Strongly encourage the use of `name` to set the name for the agent.
|
|
|
|
## 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).
|
|
|
|
## 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.
|