238 lines
17 KiB
Markdown
238 lines
17 KiB
Markdown
---
|
||
title: Using GitHub Copilot code review
|
||
shortTitle: Use code review
|
||
intro: 'Learn how to request a code review from {% data variables.product.prodname_copilot %}.'
|
||
allowTitleToDifferFromFilename: true
|
||
versions:
|
||
feature: copilot
|
||
topics:
|
||
- Copilot
|
||
redirect_from:
|
||
- /early-access/copilot/code-review/using-copilot-code-review
|
||
- /early-access/copilot/code-reviews/using-copilot-code-review
|
||
- /early-access/copilot/code-reviews/using-copilot-code-reviews
|
||
- /copilot/using-github-copilot/code-review/using-copilot-code-review
|
||
- /copilot/how-tos/agents/copilot-code-review/using-copilot-code-review
|
||
- /copilot/how-tos/agents/copilot-code-review/use-code-review
|
||
- /copilot/how-tos/agents/request-a-code-review/use-code-review
|
||
contentType: how-tos
|
||
category:
|
||
- Author and optimize with Copilot
|
||
---
|
||
|
||
## Introduction
|
||
|
||
{% 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).
|
||
|
||
{% webui %}
|
||
|
||
## Using {% data variables.copilot.copilot_code-review_short %}
|
||
|
||
These instructions explain how to use {% data variables.copilot.copilot_code-review_short %} in the {% data variables.product.github %} website. To see instructions for other popular coding environments, click the appropriate tab at the top of the page.
|
||
|
||
1. On {% data variables.product.prodname_dotcom_the_website %}, create a pull request or navigate to an existing pull request.
|
||
1. Open the **Reviewers** menu, then select **{% data variables.product.prodname_copilot_short %}**.
|
||
|
||
|
||
|
||
1. Wait for {% data variables.product.prodname_copilot_short %} to review your pull request. This usually takes less than 30 seconds.
|
||
|
||
1. Scroll down and read through {% data variables.product.prodname_copilot_short %}'s comments.
|
||
|
||
|
||
|
||
{% data variables.product.prodname_copilot_short %} always leaves a "Comment" review, not an "Approve" review or a "Request changes" review. This means that {% data variables.product.prodname_copilot_short %}'s reviews do not count toward required approvals for the pull request, and {% data variables.product.prodname_copilot_short %}'s reviews will not block merging changes. For more details, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/approving-a-pull-request-with-required-reviews).
|
||
|
||
1. {% data variables.product.prodname_copilot_short %}'s review comments behave like review comments from humans. You can add reactions to them, comment on them, resolve them and hide them.
|
||
|
||
Any comments you add to {% data variables.product.prodname_copilot_short %}'s review comments will be visible to humans, but they won't be visible to {% data variables.product.prodname_copilot_short %}, and {% data variables.product.prodname_copilot_short %} won't reply.
|
||
|
||
## Working with suggested changes provided by {% data variables.product.prodname_copilot_short %}
|
||
|
||
Where possible, {% data variables.product.prodname_copilot_short %}'s feedback includes suggested changes which you can apply with a couple of clicks.
|
||
|
||
If you're happy with the changes, you can accept a single suggestion from {% data variables.product.prodname_copilot_short %} and commit it, or accept a group of suggestions together in a single commit. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request).
|
||
|
||
You can also invoke {% data variables.copilot.copilot_coding_agent %} to implement suggested changes. To do this, you must:
|
||
|
||
* Opt into the {% data variables.release-phases.public_preview %} for {% data variables.copilot.copilot_code-review-tools_short %} and enable {% data variables.copilot.copilot_coding_agent %}.
|
||
* On review comments from {% data variables.copilot.copilot_code-review %}, click **Implement suggestion**. This creates a draft comment on the pull request, where you can instruct {% data variables.product.prodname_copilot_short %} to address specific feedback. {% data variables.product.prodname_copilot_short %} will create a new pull request against your branch with the suggestions applied.
|
||
|
||
## Providing feedback on {% data variables.product.prodname_copilot_short %}'s reviews
|
||
|
||
You can provide feedback on {% data variables.product.prodname_copilot_short %}'s comments directly within each comment. We use this information to improve the product and the quality of {% data variables.product.prodname_copilot_short %}'s suggestions.
|
||
|
||
1. On a pull request review comment from {% data variables.product.prodname_copilot_short %}, click the thumbs up (:+1:) or thumbs down (:-1:) button.
|
||
|
||
|
||
|
||
1. If you click the thumbs down button, you're asked to provide additional information. You can, optionally, pick the reason for your negative feedback and leave a comment before clicking **Submit feedback**.
|
||
|
||
|
||
|
||
## Requesting a re-review from {% data variables.product.prodname_copilot_short %}
|
||
|
||
When you push changes to a pull request that {% data variables.product.prodname_copilot_short %} has reviewed, it won't automatically re-review your changes.
|
||
|
||
To request a re-review from {% data variables.product.prodname_copilot_short %}, click the {% octicon "sync" aria-label="Re-request review" %} button next to {% data variables.product.prodname_copilot_short %}'s name in the **Reviewers** menu. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).
|
||
|
||
> [!NOTE] When re-reviewing a pull request, {% data variables.product.prodname_copilot_short %} may repeat the same comments again, even if they have been dismissed with the "Resolve conversation" button or downvoted with the thumbs down (:-1:) button.
|
||
|
||
## Enabling automatic reviews
|
||
|
||
By default, you manually request a review from {% data variables.product.prodname_copilot_short %} on each pull request, in the same way you would request a review from a human. However, you can set up {% data variables.product.prodname_copilot_short %} to automatically review all pull requests. See [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/automatic-code-review).
|
||
|
||
## Customizing {% data variables.product.prodname_copilot_short %}'s reviews with custom instructions
|
||
|
||
{% data reusables.copilot.code-review.custom-instructions-information %}
|
||
|
||
{% endwebui %}
|
||
|
||
{% vscode %}
|
||
|
||
### Reviewing a selection of code
|
||
|
||
You can request an initial review of a highlighted selection of code in {% data variables.product.prodname_vscode %}.
|
||
|
||
1. In {% data variables.product.prodname_vscode %}, select the code you want to review.
|
||
1. Right-click the selected code and choose **Generate Code** > **Review**.
|
||
1. {% data variables.product.prodname_vscode_shortname %} creates review comments in the **Comments** panel and also shows them inline in the editor.
|
||
|
||
### Reviewing all uncommitted changes
|
||
|
||
You can request a review of your uncommitted changes in {% data variables.product.prodname_vscode %}.
|
||
|
||
1. In {% data variables.product.prodname_vscode_shortname %}, click the **Source Control** button in the Activity Bar.
|
||
1. At the top of the **Source Control** view, hover over **CHANGES**, then click the {% data reusables.copilot.code-review.staging-icon-vscode %} **{% data variables.product.prodname_copilot_short %} Code Review - Uncommitted Changes** button.
|
||
|
||
|
||
|
||
1. Wait for {% data variables.product.prodname_copilot_short %} to review your changes. This usually takes less than 30 seconds.
|
||
1. If {% data variables.product.prodname_copilot_short %} has any comments, they will be shown inline in your file(s), and in the **Problems** tab.
|
||
|
||
## Working with suggested changes provided by {% data variables.product.prodname_copilot_short %}
|
||
|
||
Where possible, {% data variables.product.prodname_copilot_short %}'s feedback includes suggested changes which you can apply with a single click.
|
||
|
||
|
||
|
||
If you're happy with the change, you can accept a suggestion from {% data variables.product.prodname_copilot_short %} by clicking the **Apply and Go To Next** button. Any changes you apply will not be automatically committed.
|
||
|
||
If you don't want to apply {% data variables.product.prodname_copilot_short %}'s suggested change, click the **Discard and Go to Next** button.
|
||
|
||
## Providing feedback on {% data variables.product.prodname_copilot_short %}'s reviews
|
||
|
||
You can provide feedback on {% data variables.product.prodname_copilot_short %}'s comments directly within each comment. We use this information to improve the product and the quality of {% data variables.product.prodname_copilot_short %}'s suggestions.
|
||
|
||
To provide feedback, hover over the comment and click the thumbs up or thumbs down button.
|
||
|
||
|
||
|
||
## Customizing {% data variables.product.prodname_copilot_short %}'s reviews with custom instructions
|
||
|
||
{% data reusables.copilot.code-review.custom-instructions-information %}
|
||
|
||
{% endvscode %}
|
||
|
||
{% visualstudio %}
|
||
|
||
## Prerequisite
|
||
|
||
To use {% data variables.copilot.copilot_code-review_short %}, you must use {% data variables.product.prodname_vs %} version 17.14 or later. See the [{% data variables.product.prodname_vs %} downloads page](https://visualstudio.microsoft.com/downloads/).
|
||
|
||
## Using {% data variables.copilot.copilot_code-review_short %}
|
||
|
||
These instructions explain how to use {% data variables.copilot.copilot_code-review_short %} in {% data variables.product.prodname_vs %}. To see instructions for other popular coding environments, click the appropriate tab at the top of the page.
|
||
|
||
1. In the Git Changes window, click **Review changes with {% data variables.product.prodname_copilot_short %}**.
|
||
This button appears as a comment icon with a sparkle.
|
||
1. {% data variables.product.prodname_copilot_short %} will begin reviewing your changes. After a few moments, a link showing the number of code review comments appears in the Git Changes window.
|
||
1. Click the link to view and navigate the comments. If no issues are found, you’ll see the message:
|
||
{% data variables.product.prodname_copilot_short %} did not comment on any files.
|
||
1. {% data variables.product.prodname_copilot_short %} displays comments in your code with a summary of each potential issue. You can:
|
||
|
||
* Review and make changes based on the suggestions.
|
||
* Dismiss a comment using the downward arrow in the top-right corner of the comment box.
|
||
|
||
1. To remove all review comments, click {% octicon "x" aria-label="The X icon" %} next to the code review link in the Git Changes window.
|
||
|
||
For more information on enabling and configuring {% data variables.copilot.copilot_code-review_short %} in {% data variables.product.prodname_vs %}, see [Review local changes with {% data variables.copilot.copilot_chat_short %}](https://learn.microsoft.com/en-us/visualstudio/version-control/git-make-commit?view=vs-2022#review-local-changes-with-copilot-chat) in the {% data variables.product.prodname_vs %} documentation.
|
||
|
||
{% endvisualstudio %}
|
||
|
||
{% mobile %}
|
||
|
||
## Using {% data variables.copilot.copilot_code-review_short %}
|
||
|
||
These instructions explain how to use {% data variables.copilot.copilot_code-review_short %} in {% data variables.product.prodname_mobile %}. To see instructions for other popular coding environments, click the appropriate tab at the top of the page.
|
||
|
||
1. In {% data variables.product.prodname_mobile %}, open a pull request.
|
||
1. Scroll down to the **Reviews** section and expand it.
|
||
1. Click **Request Reviews**.
|
||
1. Add {% data variables.product.prodname_copilot_short %} as a reviewer, then click **Done**.
|
||
|
||
{% data variables.product.prodname_copilot_short %} will review the changes and provide feedback.
|
||
|
||
{% endmobile %}
|
||
|
||
{% xcode %}
|
||
|
||
## Prerequisite
|
||
|
||
To use {% data variables.copilot.copilot_code-review_short %} in Xcode, you must use version 0.41.0 or later of the {% data variables.copilot.copilot_chat %} extension. Download the latest release from the [`github/CopilotForXcode` repository](https://github.com/github/CopilotForXcode/releases/latest).
|
||
|
||
## Using {% data variables.copilot.copilot_code-review_short %}
|
||
|
||
These instructions explain how to use {% data variables.copilot.copilot_code-review_short %} in Xcode. To see instructions for other popular coding environments, click the appropriate tab at the top of the page.
|
||
|
||
1. In Xcode, make some changes to one or more files.
|
||
1. Open the {% data variables.product.prodname_copilot_short %} chat window by clicking **Editor** in the menu bar, clicking **{% data variables.product.prodname_copilot %}** then **Open Chat**.
|
||
1. Near the bottom right of the prompt box in the {% data variables.product.prodname_copilot_short %} chat window, click the **Code Review** button (a speech bubble icon).
|
||
|
||
|
||
|
||
1. Click either **Review Staged Changes** or **Review Unstaged Changes**.
|
||
1. A list of files containing changes is displayed in the chat window. Click the check boxes to deselect any files you don't want {% data variables.product.prodname_copilot_short %} to review.
|
||
1. Click **Continue** to start the review process.
|
||
1. If {% data variables.product.prodname_copilot_short %} finds things to comment on, it displays a **Reviewed Changes** list in the chat window, listing the files it has commented on. Click a file in this list to see the comments.
|
||
|
||
Each comment is shown in a popup, overlaid over the editor.
|
||
|
||
|
||
|
||
1. If there is more than one comment in the file, use the up and down arrows, at the top right of the popup, to navigate between comments.
|
||
1. {% data variables.product.prodname_copilot_short %} may suggest replacement code. You can apply the suggested change by clicking **Accept** or reject it by clicking **Dismiss**.
|
||
1. Click another file in the **Reviewed Changes** list in the chat window, to see the review comments for another file.
|
||
|
||
{% endxcode %}
|
||
|
||
{% jetbrains %}
|
||
|
||
## Prerequisites
|
||
|
||
* **Access to {% data variables.product.prodname_copilot_short %}**. {% data reusables.copilot.subscription-prerequisite %}
|
||
|
||
* **Compatible JetBrains IDE**. To use {% data variables.product.prodname_copilot %} in JetBrains, you must have a compatible JetBrains IDE installed. {% data variables.product.prodname_copilot %} is compatible with the following IDEs:
|
||
|
||
{% data reusables.copilot.jetbrains-compatible-ides %}
|
||
|
||
{% data reusables.copilot.jetbrains-plugin-prerequisites %}
|
||
|
||
## Using {% data variables.copilot.copilot_code-review_short %}
|
||
|
||
These instructions explain how to use {% data variables.copilot.copilot_code-review_short %} in JetBrains IDEs. To see instructions for other popular coding environments, click the appropriate tab at the top of the page.
|
||
|
||
1. In a JetBrains IDE, make some changes to one or more files.
|
||
1. Open the "Commit" tool window on the left-hand side.
|
||
1. Above the commit message input field, click **Copilot: Review Code Changes**. This button appears as a magnifying glass icon with a sparkle.
|
||
1. {% data variables.product.prodname_copilot_short %} will begin reviewing your changes.
|
||
1. {% data variables.product.prodname_copilot_short %} displays comments in your code with a summary of each potential issue. You can:
|
||
|
||
* Review and make changes based on the suggestions.
|
||
* Dismiss a comment by clicking **Discard**.
|
||
1. If there is more than one comment, use the up and down arrows, at the top right of the popup, to navigate between comments.
|
||
|
||
{% endjetbrains %}
|