|
1 | | -When performing a code review, validate that there are changes in the `README.md` file that match the changes in the pull request. If there are no changes, or if the changes do not match, then the pull request is not ready to be merged. |
| 1 | +The following instructions are only to be applied when performing a code review. |
2 | 2 |
|
3 | | -When performing a code review, ensure that the values in the front matter are wrapped in single quotes. |
| 3 | +## README updates |
4 | 4 |
|
5 | | -When performing a code review, ensure that the `description` field in the front matter is not empty. |
| 5 | +* [ ] The new file should be added to the `README.md`. |
6 | 6 |
|
7 | | -When performing a code review on a `.instructions.md` file, ensure there is an `applyTo` property in the front matter that specifies the file or files to which the instructions apply. |
| 7 | +## Prompt file guide |
| 8 | + |
| 9 | +**Only apply to files that end in `.prompt.md`** |
| 10 | + |
| 11 | +* [ ] The prompt has markdown front matter. |
| 12 | +* [ ] The prompt has a `mode` field specified of either `agent` or `ask`. |
| 13 | +* [ ] The prompt has a `description` field. |
| 14 | +* [ ] The `description` field is not empty. |
| 15 | +* [ ] The `description` field value is wrapped in single quotes. |
| 16 | +* [ ] The file name is lower case, with words separated by hyphens. |
| 17 | +* [ ] Encourage the use of `tools`, but it's not required. |
| 18 | +* [ ] Strongly encourage the use of `model` to specify the model that the prompt is optimised for. |
| 19 | + |
| 20 | +## Instruction file guide |
| 21 | + |
| 22 | +**Only apply to files that end in `.instructions.md`** |
| 23 | + |
| 24 | +* [ ] The instruction has markdown front matter. |
| 25 | +* [ ] The instruction has a `description` field. |
| 26 | +* [ ] The `description` field is not empty. |
| 27 | +* [ ] The `description` field value is wrapped in single quotes. |
| 28 | +* [ ] The file name is lower case, with words separated by hyphens. |
| 29 | +* [ ] 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'`. |
| 30 | + |
| 31 | +## Chat Mode file guide |
| 32 | + |
| 33 | +**Only apply to files that end in `.chatmode.md`** |
| 34 | + |
| 35 | +* [ ] The chat mode has markdown front matter. |
| 36 | +* [ ] The chat mode has a `description` field. |
| 37 | +* [ ] The `description` field is not empty. |
| 38 | +* [ ] The `description` field value is wrapped in single quotes. |
| 39 | +* [ ] The file name is lower case, with words separated by hyphens. |
| 40 | +* [ ] Encourage the use of `tools`, but it's not required. |
| 41 | +* [ ] Strongly encourage the use of `model` to specify the model that the chat mode is optimised for. |
0 commit comments