Copilot instructions are GitHub's standardized way of adding such a AI-coding-handbook specifically for GitHub Copilot and Microsoft VS Code.

Suggest add comprehensive Copilot instructions to improve agent development efficiency for zigpy repo, similar to PR in Z2M's zigbee-herdsman:

• chore: add copilot prompts Koenkk/zigbee-herdsman#1523

  • https://github.com/Koenkk/zigbee-herdsman/blob/master/.github/copilot-instructions.md

    • https://github.com/Koenkk/zigbee-herdsman/tree/master/.github/prompts

Nerivec also added somewhat similar Copilot instructions and promts to both Koenkk's zigbee2mqtt repo (their Z2M equivalent to https://github.com/zigpy/zha ) and zigbee-on-host repos/projects as well (their equivalen to https://github.com/zigpy/ziggurat ):

• https://github.com/Koenkk/zigbee2mqtt/blob/master/.github/copilot-instructions.md

and

• Add comprehensive Copilot instructions to improve agent development efficiency Nerivec/zigbee-on-host#69

  • https://github.com/Nerivec/zigbee-on-host/blob/main/.github/copilot-instructions.md

    • https://github.com/Nerivec/zigbee-on-host/tree/main/.github/prompts

Those instructions and promts help GitHub Copilot reviews which looks to have benefited their project. See these references:

• https://docs.github.com/en/copilot/how-tos/configure-custom-instructions
  • https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions
  • https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-organization-instructions
• https://github.blog/ai-and-ml/github-copilot/5-tips-for-writing-better-custom-instructions-for-copilot/
• https://copilot-instructions.md/
• https://code.visualstudio.com/docs/copilot/customization/custom-instructions
• https://github.com/github/awesome-copilot
  • https://developer.microsoft.com/blog/introducing-awesome-github-copilot-customizations-repo
• https://dev.to/louis7/3-minute-guide-make-github-copilot-generate-high-quality-code-2cph
  • https://medium.com/@frank.laule/mastering-github-copilot-customization-with-copilot-instructions-83e8cc1ca10a
    • https://github.com/SebastienDegodez/copilot-instructions

GitHub Copilot should have a "Copilot Instructions Blueprint Generator" that could help generate instructions and promts.

PS: Also see similar request for zha and ziggurat:

• [SUGGESTION] Add comprehensive Copilot instructions and promts to zha GitHub repo for improved agent development efficiency zha#546
• [SUGGESTION] Add comprehensive Copilot instructions and promts to ziggurat GitHub repo for improved agent development efficiency ziggurat#24