Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ topics:
- Copilot
redirect_from:
- /copilot/code-review
- /copilot/concepts/code-review/code-review
contentType: concepts
---

Expand Down Expand Up @@ -51,11 +52,11 @@ When you reach your monthly quota you will not be able to get a code review from
* **Review selection:**
* Highlight code and ask for an initial review.
* Standard {% data variables.product.prodname_copilot_short %} feature. No premium requests used.
* Does not support custom instructions or custom coding guidelines.
* Does not support custom instructions.
* **Review changes:**
* Request a deeper review of all of your uncommitted changes.
* Premium feature. Uses one premium request from your monthly quota per review.
* Supports custom instructions and custom coding guidelines.
* Supports custom instructions.

## Providing instructions for {% data variables.product.prodname_copilot_short %} code reviews

Expand Down
76 changes: 0 additions & 76 deletions content/copilot/concepts/code-review/coding-guidelines.md

This file was deleted.

15 changes: 0 additions & 15 deletions content/copilot/concepts/code-review/index.md

This file was deleted.

1 change: 1 addition & 0 deletions content/copilot/concepts/response-customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ topics:
redirect_from:
- /copilot/customizing-copilot/about-customizing-github-copilot-chat-responses
- /copilot/concepts/about-customizing-github-copilot-chat-responses
- /copilot/concepts/code-review/coding-guidelines
contentType: concepts
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ contentType: how-tos

This policy controls the use of {% data variables.copilot.copilot_code-review_short %} and {% data variables.copilot.copilot_for_prs %} in your enterprise.

For an introduction to {% data variables.copilot.copilot_code-review_short %}, see [AUTOTITLE](/copilot/concepts/code-review/code-review).
For an introduction to {% data variables.copilot.copilot_code-review_short %}, see [AUTOTITLE](/copilot/concepts/code-review).

For more information about {% data variables.copilot.copilot_for_prs %}, see [AUTOTITLE](/copilot/how-tos/use-copilot-for-common-tasks/create-a-pr-summary).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,17 @@
title: Adding repository custom instructions for GitHub Copilot
shortTitle: Add repository instructions
intro: 'Create repository custom instructions files that give {% data variables.product.prodname_copilot_short %} additional context on how to understand your project and how to build, test and validate its changes.'
redirect_from:
- /copilot/customizing-copilot/adding-custom-instructions-for-github-copilot
- /copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot
- /copilot/how-tos/custom-instructions/adding-repository-custom-instructions-for-github-copilot
- /copilot/how-tos/custom-instructions/add-repository-instructions
versions:
feature: copilot
topics:
- Copilot
contentType: how-tos
redirect_from:
- /copilot/customizing-copilot/adding-custom-instructions-for-github-copilot
- /copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot
- /copilot/how-tos/custom-instructions/adding-repository-custom-instructions-for-github-copilot
- /copilot/how-tos/custom-instructions/add-repository-instructions
- /copilot/how-tos/use-copilot-agents/request-a-code-review/configure-coding-guidelines
---

{% webui %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ contentType: how-tos

## Introduction

This article tells you how to set up {% data variables.copilot.copilot_code-review_short %} to review pull requests automatically. For an overview of automatic pull request reviews, see [AUTOTITLE](/copilot/concepts/code-review/code-review#about-automatic-pull-request-reviews).
This article tells you how to set up {% data variables.copilot.copilot_code-review_short %} to review pull requests automatically. For an overview of automatic pull request reviews, see [AUTOTITLE](/copilot/concepts/code-review#about-automatic-pull-request-reviews).

The three sections in this article tell you how to configure automatic code review for:

Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ topics:
- Copilot
children:
- /use-code-review
- /configure-coding-guidelines
- /configure-automatic-review
redirect_from:
- /copilot/using-github-copilot/code-review
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ contentType: how-tos

{% data variables.product.prodname_copilot %} can review your code and provide feedback. Where possible, {% data variables.product.prodname_copilot_short %}'s feedback includes suggested changes which you can apply with a couple of clicks.

For a full introduction to {% data variables.copilot.copilot_code-review %}, see [AUTOTITLE](/copilot/concepts/code-review/code-review).
For a full introduction to {% data variables.copilot.copilot_code-review %}, see [AUTOTITLE](/copilot/concepts/code-review).

{% webui %}

Expand Down Expand Up @@ -81,10 +81,6 @@ By default, you manually request a review from {% data variables.product.prodnam

{% data reusables.copilot.code-review.custom-instructions-information %}

## Customizing {% data variables.product.prodname_copilot_short %}'s reviews with coding guidelines

{% data reusables.copilot.code-review.custom-coding-guidelines %}

{% endwebui %}

{% vscode %}
Expand Down Expand Up @@ -140,10 +136,6 @@ To provide feedback, hover over the comment and click the thumbs up or thumbs do

{% data reusables.copilot.code-review.custom-instructions-information %}

## Customizing {% data variables.product.prodname_copilot_short %}'s reviews with coding guidelines

{% data reusables.copilot.code-review.custom-coding-guidelines %}

{% endvscode %}

{% visualstudio %}
Expand Down
8 changes: 4 additions & 4 deletions content/copilot/responsible-use/code-review.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ contentType: rai

When a user requests a code review from {% data variables.product.prodname_copilot_short %}, {% data variables.product.prodname_copilot_short %} scans through the code changes, plus additional relevant context, and provides feedback on the code. As part of that feedback, it may also provide specific suggested code changes.

{% data variables.product.prodname_copilot_short %}'s review can be customized with coding guidelines, which are natural language descriptions of coding style and best practices. For more information, see [AUTOTITLE](/copilot/using-github-copilot/code-review/configuring-coding-guidelines).
{% data variables.product.prodname_copilot_short %}'s review can be customized with custom instructions, which are natural language descriptions of coding style and best practices. For more information, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions).

The only supported language for {% data variables.copilot.copilot_code-review %} is English.

{% data variables.copilot.copilot_code-review %} inspects your code and provides feedback using a combination of natural language processing and machine learning. This process can be broken down into a number of steps.

### Input processing

The code changes are combined with other relevant, contextual information (for example, the pull request’s title and body on {% data variables.product.github %}) and your coding guidelines to form a prompt, and that prompt is sent to a large language model.
The code changes are combined with other relevant, contextual information (for example, the pull request’s title and body on {% data variables.product.github %}), and any custom instructions that have been defined, to form a prompt, and that prompt is sent to a large language model.

### Language model analysis

Expand Down Expand Up @@ -61,9 +61,9 @@ You should always review and verify the feedback generated by {% data variables.

If you encounter any issues or limitations with {% data variables.copilot.copilot_code-review_short %}, we recommend that you provide feedback by using the thumbs up and thumbs down buttons on {% data variables.product.prodname_copilot_short %}'s comments. This can help GitHub to improve the tool and address any concerns or limitations.

### Configure coding guidelines
### Custom instructions

You can configure coding guidelines to help {% data variables.product.prodname_copilot_short %} understand your coding style and best practices. For more information, see [AUTOTITLE](/copilot/using-github-copilot/code-review/configuring-coding-guidelines).
You can configure custom instructions to help {% data variables.product.prodname_copilot_short %} understand your coding style and best practices. For more information, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions).

## Limitations of {% data variables.copilot.copilot_code-review %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ By leveraging {% data variables.product.prodname_copilot_short %}'s capabilities

* {% data variables.product.prodname_copilot_short %} can review code changes in your IDE before opening a pull request, or be assigned as reviewer to a pull request.
* With rulesets, you can set up {% data variables.product.prodname_copilot_short %} to systematically review pull requests based on custom criteria.
* With coding guidelines for reviews ({% data variables.copilot.copilot_enterprise_short %} only), {% data variables.product.prodname_copilot_short %} can enforce organizational coding standards and best practices, automatically flagging potential violations and suggesting fixes.
* With custom instructions for reviews, {% data variables.product.prodname_copilot_short %} can enforce organizational coding standards and best practices, automatically flagging potential violations and suggesting fixes.

These features ensure consistency across the codebase and help you catch errors early in the development process, reducing the need for manual code reviews and saving time for developers and reviewers.

Expand Down Expand Up @@ -124,8 +124,8 @@ Using {% data variables.product.prodname_copilot_short %} code review does not r

* **Developers** should request a review of all their changes using {% data variables.product.prodname_copilot_short %} code review before opening a pull request.
* **Administrators** should set up repository or organization rulesets to automatically add {% data variables.product.prodname_copilot_short %} as a reviewer on any pull request targeting protected branches.
* **Team leads** should capture their team's standard style and rules and set them as coding guidelines for the organization so that {% data variables.product.prodname_copilot_short %} can leverage them in reviews.
* Ensure your coding guidelines capture a minimum set of styling recommendations that make code more readable, which will help during the pull request review process.
* **Team leads** should capture their team's standard style and rules and set them as custom instructions for the organization so that {% data variables.product.prodname_copilot_short %} can leverage them in reviews.
* Ensure your custom instructions capture a minimum set of styling recommendations that make code more readable, which will help during the pull request review process.
* To reduce the amount of PR review comments due to styling issues, set the same recommendations in {% data variables.product.prodname_copilot_short %} instructions at the repository and organization level. This way, the code generated by {% data variables.product.prodname_copilot_short %} will conform to these guidelines.

### Get help implementing review comments
Expand Down Expand Up @@ -154,7 +154,7 @@ Developers **should not**:

* [AUTOTITLE](/copilot/using-github-copilot/using-github-copilot-for-pull-requests/creating-a-pull-request-summary-with-github-copilot)
* [AUTOTITLE](/copilot/using-github-copilot/code-review/using-copilot-code-review?tool=vscode#reviewing-changes)
* [AUTOTITLE](/copilot/using-github-copilot/code-review/configuring-coding-guidelines)
* [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions)
* [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/automatic-code-review)
* [AUTOTITLE](/copilot/customizing-copilot/adding-organization-custom-instructions-for-github-copilot)

Expand Down
Loading
Loading