josiadmin/awesome-copilot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
awesome-copilot/.github/copilot-instructions.md

2.1 KiB
Raw Blame History

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

Branching Policy

  • Always create a new branch for each task, feature, or fix.
  • Use the following naming conventions:
    • feature/<short-description>
    • bugfix/<short-description>
    • task/<short-description>
  • Never commit changes directly to the main or default branch.
  • After completing changes, push the branch and open a pull request for review and merging.