5caacba89a
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com>
2.4 KiB
Support for repository custom instructions
The following table shows which {% data variables.product.prodname_copilot_short %} features support custom instructions in various environments.
{% rowheaders %}
| Eclipse | JetBrains IDEs | {% data variables.product.prodname_vs %} | {% data variables.product.prodname_vscode_shortname %} | {% data variables.product.prodname_dotcom_the_website %} | Xcode | |
|---|---|---|---|---|---|---|
| {% data variables.copilot.copilot_chat_short %} | {% octicon "check" aria-label="Included" %} 1 | {% octicon "check" aria-label="Included" %} 1 | {% octicon "check" aria-label="Included" %} 2 | {% octicon "check" aria-label="Included" %} 3 | {% octicon "check" aria-label="Included" %} 1 | {% octicon "check" aria-label="Included" %} 1 |
| {% data variables.copilot.copilot_coding_agent %} | N/A | N/A | N/A | {% octicon "check" aria-label="Included" %} 4 | {% octicon "check" aria-label="Included" %} 4 | N/A |
| {% data variables.copilot.copilot_code-review_short %} | N/A | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} 1 | {% octicon "check" aria-label="Included" %} 1 | {% octicon "check" aria-label="Included" %} 2 | {% octicon "x" aria-label="Not included" %} |
{% endrowheaders %}
Types of custom instructions supported
1: Repository-wide instructions (using the .github/copilot-instructions.md file).
2: Repository-wide instructions and path-specific instructions (using .github/instructions/**/NAME.instructions.md files).
3: Repository-wide instructions, path-specific instructions, and agent instructions (using AGENTS.md files).
4: Repository-wide instructions, path-specific instructions, and agent instructions (using AGENTS.md, CLAUDE.md or GEMINI.md files).
X: Custom instructions are not supported.
N/A: Feature not available on this platform.
Note
{% data variables.copilot.copilot_code-review_short %} only reads the first 4,000 characters of any custom instruction file. Any instructions beyond this limit will not affect the reviews generated by {% data variables.copilot.copilot_code-review_short %}. This limit does not apply to {% data variables.copilot.copilot_chat_short %} or {% data variables.copilot.copilot_coding_agent %}.