You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/copilot/concepts/agents/code-review.md
+2-15Lines changed: 2 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,15 +61,13 @@ In the event that {% data variables.product.prodname_actions %} is unavailable o
61
61
* Xcode
62
62
* JetBrains IDEs
63
63
64
-
{% data variables.copilot.copilot_code-review_short %} is—with one exception—a premium feature, available with the {% data variables.copilot.copilot_pro_short %}, {% data variables.copilot.copilot_pro_plus_short %}, {% data variables.copilot.copilot_business_short %}, and {% data variables.copilot.copilot_enterprise_short %} plans. See [Copilot plans](https://github.com/features/copilot/plans?ref_product=copilot&ref_type=purchase&ref_style=text&utm_source=docs-signup-copilot&utm_medium=docs&utm_campaign=universe25post).
65
-
66
-
The exception is the review of a selection of code within a file in {% data variables.product.prodname_vscode %}. This is a standard feature available to all {% data variables.product.prodname_copilot_short %} users in {% data variables.product.prodname_vscode_shortname %}.
64
+
{% data variables.copilot.copilot_code-review_short %} is a premium feature, available with the {% data variables.copilot.copilot_pro_short %}, {% data variables.copilot.copilot_pro_plus_short %}, {% data variables.copilot.copilot_business_short %}, and {% data variables.copilot.copilot_enterprise_short %} plans. See [Copilot plans](https://github.com/features/copilot/plans?ref_product=copilot&ref_type=purchase&ref_style=text&utm_source=docs-signup-copilot&utm_medium=docs&utm_campaign=universe25post).
67
65
68
66
If you receive {% data variables.product.prodname_copilot_short %} from an organization then, to be able to request a pull request review from {% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %} or in {% data variables.product.prodname_mobile %}, the **{% data variables.copilot.copilot_code-review_short %}** option must be enabled in the {% data variables.product.prodname_copilot_short %} policy settings for the organization. See [AUTOTITLE](/copilot/how-tos/administer/organizations/managing-policies-for-copilot-in-your-organization).
69
67
70
68
## Code review monthly quota
71
69
72
-
Each time {% data variables.product.prodname_copilot_short %} reviews a pull request, or reviews files in your IDE that contain uncommitted changes, your monthly quota of Copilot premium requests is reduced by one. Code review for currently selected text in {% data variables.product.prodname_vscode_shortname %} does not consume a premium request. For information about premium requests, see [AUTOTITLE](/copilot/managing-copilot/monitoring-usage-and-entitlements/about-premium-requests).
70
+
Each time {% data variables.product.prodname_copilot_short %} reviews a pull request, or reviews code in your IDE, your monthly quota of Copilot premium requests is reduced by one.
73
71
74
72
If a repository is configured to automatically request a code review from {% data variables.product.prodname_copilot_short %} for all new pull requests, the premium request usage is applied to the quota of the pull request author. If a pull request is created by {% data variables.product.prodname_actions %} or by a bot, the usage will apply to the user who triggered the workflow (if identifiable), or to a designated billing owner.
75
73
@@ -81,17 +79,6 @@ When you reach your monthly quota you will not be able to get a code review from
81
79
82
80
{% data reusables.copilot.ccr-model-settings %}
83
81
84
-
## {% data variables.copilot.copilot_code-review_short %} in {% data variables.product.prodname_vscode %}
85
-
86
-
{% data variables.copilot.copilot_code-review_short %} in {% data variables.product.prodname_vscode %} supports two types of review:
87
-
88
-
***Review selection:**
89
-
* Highlight code and ask for an initial review.
90
-
* Standard {% data variables.product.prodname_copilot_short %} feature. No premium requests used.
91
-
***Review changes:**
92
-
* Request a deeper review of all of your uncommitted changes.
93
-
* Premium feature. Uses one premium request from your monthly quota per review.
94
-
95
82
## Providing instructions for {% data variables.product.prodname_copilot_short %} code reviews
96
83
97
84
You can tailor the reviews that {% data variables.product.prodname_copilot_short %} generates by providing custom instructions. This helps {% data variables.product.prodname_copilot_short %} to review the code in a way that matches your team's coding standards, tools, and practices. See [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions?tool=webui) and [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-organization-instructions).
Copy file name to clipboardExpand all lines: content/copilot/concepts/prompting/response-customization.md
+18Lines changed: 18 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,6 +26,8 @@ category:
26
26
27
27
{% data variables.product.prodname_copilot %} can provide responses that are tailored to your personal preferences, the way your team works, the tools you use, or the specifics of your project, if you provide it with enough context to do so. Instead of repeatedly adding this contextual detail to your prompts, you can create custom instructions that automatically add this information for you. The additional information is not displayed, but is available to {% data variables.product.prodname_copilot_short %} to allow it to generate higher quality responses.
28
28
29
+
{% data reusables.copilot.custom-insts-nondeterministic %}
30
+
29
31
## Types of custom instructions
30
32
31
33
There are three main types of custom instructions that you can use to customize {% data variables.product.prodname_copilot_short %} responses on the {% data variables.product.github %} website:
@@ -122,6 +124,8 @@ There are two types of files you can use to provide context and instructions to
122
124
123
125
While custom instructions help to add codebase-wide context to each AI workflow, prompt files let you add instructions to a specific chat interaction.
124
126
127
+
{% data reusables.copilot.custom-insts-nondeterministic %}
128
+
125
129
## About repository custom instructions
126
130
127
131
You can use three types of repository custom instructions in {% data variables.product.prodname_vscode_shortname %}:
@@ -179,11 +183,14 @@ The following examples demonstrate how to use prompt files.
179
183
…
180
184
```
181
185
186
+
For information on how to enable, create, and use prompt files, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions?tool=vscode#enabling-and-using-prompt-files).
187
+
182
188
{% data reusables.copilot.custom-instructions-effective %}
@@ -199,6 +206,8 @@ The following examples demonstrate how to use prompt files.
199
206
200
207
{% data variables.product.prodname_copilot %} can provide responses that are tailored to the way your team works, the tools you use, or the specifics of your project, if you provide it with enough context to do so. Instead of repeatedly adding this contextual detail to your prompts, you can create a custom instructions file in your repository that automatically adds this information for you. The additional information is not displayed in the chat input box, but is available to {% data variables.product.prodname_copilot_short %} to allow it to generate higher quality responses.
201
208
209
+
{% data reusables.copilot.custom-insts-nondeterministic %}
210
+
202
211
## About repository custom instructions
203
212
204
213
In {% data variables.product.prodname_vs %}, repository custom instructions consist of a single file, `.github/copilot-instructions.md`, that you create in a repository. The instructions you add to the file should be short, self-contained statements that add context or relevant information to supplement a {% data variables.product.prodname_copilot_short %} prompt.
@@ -246,6 +255,8 @@ There are two types of files you can use to provide context and instructions to
246
255
247
256
While custom instructions help to add codebase-wide context to each AI workflow, prompt files let you add instructions to a specific chat interaction.
248
257
258
+
{% data reusables.copilot.custom-insts-nondeterministic %}
259
+
249
260
## About repository custom instructions
250
261
251
262
In JetBrains IDEs, repository custom instructions consist of a single file, `.github/copilot-instructions.md`, that you create in a repository. The instructions you add to the file should be short, self-contained statements that add context or relevant information to supplement a {% data variables.product.prodname_copilot_short %} prompt.
@@ -322,6 +333,7 @@ For a curated collection of examples, see [AUTOTITLE](/copilot/tutorials/customi
@@ -337,6 +349,8 @@ For a curated collection of examples, see [AUTOTITLE](/copilot/tutorials/customi
337
349
338
350
{% data variables.product.prodname_copilot %} can provide responses that are tailored to the way your team works, the tools you use, or the specifics of your project, if you provide it with enough context to do so. Instead of repeatedly adding this contextual detail to your prompts, you can create a custom instructions file in your repository that automatically adds this information for you. The additional information is not displayed in the chat input box, but is available to {% data variables.product.prodname_copilot_short %} to allow it to generate higher quality responses.
339
351
352
+
{% data reusables.copilot.custom-insts-nondeterministic %}
353
+
340
354
## About repository custom instructions
341
355
342
356
In Xcode, repository custom instructions consist of a single file, `.github/copilot-instructions.md`, that you create in a repository. The instructions you add to the file should be short, self-contained statements that add context or relevant information to supplement a {% data variables.product.prodname_copilot_short %} prompt.
@@ -362,6 +376,7 @@ For a curated collection of examples, see [AUTOTITLE](/copilot/tutorials/customi
@@ -382,6 +397,8 @@ There are two types of repository custom instructions you can use to provide con
382
397
***Workspace custom instructions** which apply to all projects in a workspace, and allow you to specify workspace-wide instructions and preferences, in a single file.
383
398
***Project custom instructions** which apply to a specific project.
384
399
400
+
{% data reusables.copilot.custom-insts-nondeterministic %}
401
+
385
402
## About repository custom instructions
386
403
387
404
**Workspace custom instructions** apply to all projects in a workspace, and allow you to specify workspace-wide instructions and preferences. You can use workspace custom instructions to provide context and instructions to {% data variables.product.prodname_copilot_short %} in Eclipse.
@@ -405,6 +422,7 @@ For a curated collection of examples, see [AUTOTITLE](/copilot/tutorials/customi
Copy file name to clipboardExpand all lines: data/reusables/copilot/custom-instructions-path.md
+10-2Lines changed: 10 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,12 +20,20 @@
20
20
---
21
21
```
22
22
23
-
To apply the instructions to all files, use `applyTo: "**"`, `applyTo: "*"`, or `applyTo: "**/*"`.
23
+
Glob examples:
24
+
25
+
*`*` - will all match all files in the current directory.
26
+
*`**` or `**/*` - will all match all files in all directories.
27
+
*`*.py` - will match all `.py` files in the current directory.
28
+
*`**/*.py` - will recursively match all `.py` files in all directories.
29
+
*`src/*.py` - will match all `.py` files in the `src` directory. For example, `src/foo.py` and `src/bar.py` but _not_`src/foo/bar.py`.
30
+
*`src/**/*.py` - will recursively match all `.py` files in the `src` directory. For example, `src/foo.py`, `src/foo/bar.py`, and `src/foo/bar/baz.py`.
31
+
*`**/subdir/**/*.py` - will recursively match all `.py` files in any `subdir` directory at any depth. For example, `subdir/foo.py`, `subdir/nested/bar.py`, `parent/subdir/baz.py`, and `deep/parent/subdir/nested/qux.py`, but _not_`foo.py` at a path that does not contain a `subdir` directory.
24
32
25
33
1. Optionally, to prevent the file from being used by either {% data variables.copilot.copilot_coding_agent %} or {% data variables.copilot.copilot_code-review_short %}, add the `excludeAgent` keyword to the frontmatter block. Use either `"code-review"` or `"coding-agent"`.
26
34
27
35
For example, the following file will only be read by {% data variables.copilot.copilot_coding_agent %}.
> Due to the non-deterministic nature of AI, {% data variables.product.prodname_copilot_short %} may not always follow your custom instructions in exactly the same way every time they are used.
0 commit comments