1
0
mirror of synced 2025-12-19 18:10:59 -05:00
Files
docs/content/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review.md
2025-09-01 13:37:40 +00:00

16 KiB
Raw Blame History

title, shortTitle, intro, allowTitleToDifferFromFilename, versions, topics, redirect_from, contentType
title shortTitle intro allowTitleToDifferFromFilename versions topics redirect_from contentType
Using GitHub Copilot code review Use code review Learn how to request a code review from {% data variables.product.prodname_copilot %}. true
feature
copilot
Copilot
/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
how-tos

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.

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

  2. Open the Reviewers menu, then select {% data variables.product.prodname_copilot_short %}.

    Screenshot of selecting '{% data variables.product.prodname_copilot_short %}' from the 'Reviewers' menu.

  3. Wait for {% data variables.product.prodname_copilot_short %} to review your pull request. This usually takes less than 30 seconds.

  4. Scroll down and read through {% data variables.product.prodname_copilot_short %}'s comments.

    Screenshot of a code review left by {% data variables.product.prodname_copilot_short %}.

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

  5. {% 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.

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 (👍) or thumbs down (👎) button.

    Screenshot showing a {% data variables.copilot.copilot_code-review_short %} comment with the thumbs up and thumbs down buttons.

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

    Screenshot of the form for providing additional information when you give negative feedback on a comment from {% data variables.product.prodname_copilot_short %}.

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.

[!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 (👎) 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.

Customizing {% data variables.product.prodname_copilot_short %}'s reviews with custom instructions

{% 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 %}

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.

  2. Open the {% data variables.product.prodname_vscode_command_palette_shortname %}

    • For Mac:
      • Use: Shift+Command+P
    • For Windows or Linux:
      • Use Ctrl+Shift+P
  3. In the command palette, search for and select {% data variables.product.prodname_copilot %}: Review and Comment.

    Screenshot of the command palette in {% data variables.product.prodname_vscode %} with the {% data variables.product.prodname_copilot %}: Review and Comment command selected.

  4. Wait for {% data variables.product.prodname_copilot_short %} to review your changes. This usually takes less than 30 seconds.

  5. If {% data variables.product.prodname_copilot_short %} has any comments, they will be shown inline in your file, and in the Problems tab.

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.

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

    Screenshot of the "Source Control" view. The code review button is outlined in dark orange.

  3. Wait for {% data variables.product.prodname_copilot_short %} to review your changes. This usually takes less than 30 seconds.

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

Screenshot of a comment from {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_vscode %} with a suggested change.

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.

Screenshot of a comment from {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_vscode %} with feedback buttons displayed. The buttons are outlined in dark orange.

Customizing {% data variables.product.prodname_copilot_short %}'s reviews with custom instructions

{% 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 %}

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.

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.

  2. {% 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.

  3. Click the link to view and navigate the comments. If no issues are found, youll see the message: {% data variables.product.prodname_copilot_short %} did not comment on any files.

  4. {% 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.
  5. 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 %} 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.
  2. Scroll down to the Reviews section and expand it.
  3. Click Request Reviews.
  4. 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.

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.

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

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

    Screenshot of the {% data variables.product.prodname_copilot_short %} chat window in Xcode, with the 'Code Review' button outlined in dark orange.

  4. Click either Review Staged Changes or Review Unstaged Changes.

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

  6. Click Continue to start the review process.

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

    Screenshot of a {% data variables.copilot.copilot_code-review_short %} review comment.

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

  9. {% 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.

  10. Click another file in the Reviewed Changes list in the chat window, to see the review comments for another file.

{% endxcode %}