Skip to content

Commit ece273b

Browse files
authored
Merge pull request #41311 from github/repo-sync
Repo sync
2 parents 60e6a7e + 8251ba8 commit ece273b

File tree

5 files changed

+33
-17
lines changed

5 files changed

+33
-17
lines changed

content/copilot/concepts/agents/code-review.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,13 @@ In the event that {% data variables.product.prodname_actions %} is unavailable o
6161
* Xcode
6262
* JetBrains IDEs
6363

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).
6765

6866
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).
6967

7068
## Code review monthly quota
7169

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

7472
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.
7573

@@ -81,17 +79,6 @@ When you reach your monthly quota you will not be able to get a code review from
8179

8280
{% data reusables.copilot.ccr-model-settings %}
8381

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-
9582
## Providing instructions for {% data variables.product.prodname_copilot_short %} code reviews
9683

9784
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).

content/copilot/concepts/prompting/response-customization.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ category:
2626

2727
{% 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.
2828

29+
{% data reusables.copilot.custom-insts-nondeterministic %}
30+
2931
## Types of custom instructions
3032

3133
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
122124

123125
While custom instructions help to add codebase-wide context to each AI workflow, prompt files let you add instructions to a specific chat interaction.
124126

127+
{% data reusables.copilot.custom-insts-nondeterministic %}
128+
125129
## About repository custom instructions
126130

127131
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.
179183
180184
```
181185

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+
182188
{% data reusables.copilot.custom-instructions-effective %}
183189

184190
## Next steps
185191

186192
* [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
193+
* [AUTOTITLE](/copilot/tutorials/use-custom-instructions)
187194

188195
{% endvscode %}
189196

@@ -199,6 +206,8 @@ The following examples demonstrate how to use prompt files.
199206

200207
{% 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.
201208

209+
{% data reusables.copilot.custom-insts-nondeterministic %}
210+
202211
## About repository custom instructions
203212

204213
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
246255

247256
While custom instructions help to add codebase-wide context to each AI workflow, prompt files let you add instructions to a specific chat interaction.
248257

258+
{% data reusables.copilot.custom-insts-nondeterministic %}
259+
249260
## About repository custom instructions
250261

251262
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
322333
## Next steps
323334

324335
* [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
336+
* [AUTOTITLE](/copilot/tutorials/use-custom-instructions)
325337

326338
{% endjetbrains %}
327339

@@ -337,6 +349,8 @@ For a curated collection of examples, see [AUTOTITLE](/copilot/tutorials/customi
337349

338350
{% 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.
339351

352+
{% data reusables.copilot.custom-insts-nondeterministic %}
353+
340354
## About repository custom instructions
341355

342356
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
362376
## Next steps
363377

364378
* [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
379+
* [AUTOTITLE](/copilot/tutorials/use-custom-instructions)
365380

366381
{% endxcode %}
367382

@@ -382,6 +397,8 @@ There are two types of repository custom instructions you can use to provide con
382397
* **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.
383398
* **Project custom instructions** which apply to a specific project.
384399

400+
{% data reusables.copilot.custom-insts-nondeterministic %}
401+
385402
## About repository custom instructions
386403

387404
**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
405422
## Next steps
406423

407424
* [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
425+
* [AUTOTITLE](/copilot/tutorials/use-custom-instructions)
408426

409427
{% endeclipse %}
410428

content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -645,6 +645,7 @@ Once prompt files are saved, their instructions will apply to the current worksp
645645

646646
## Further reading
647647

648+
* [AUTOTITLE](/copilot/tutorials/use-custom-instructions)
648649
* [AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions)—a curated collection of examples
649650

650651
{% endcopilotcli %}

data/reusables/copilot/custom-instructions-path.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,20 @@
2020
---
2121
```
2222

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

2533
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"`.
2634

2735
For example, the following file will only be read by {% data variables.copilot.copilot_coding_agent %}.
28-
36+
2937
```markdown
3038
---
3139
applyTo: "**"
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
> [!NOTE]
2+
> 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

Comments
 (0)