跳至主要内容

使用 GitHub Copilot 代码审查

了解如何从 GitHub Copilot 请求代码审查。

简介

GitHub Copilot 可以审查你的代码并提供反馈。在可能的情况下,Copilot 的反馈会包括建议的更改,你只需点击几下即可应用。

要完整了解 GitHub Copilot 代码审查,请参阅 关于 GitHub Copilot 代码审查

即使组织成员没有 Copilot 许可证,只要企业管理员或组织所有者启用,也可以使用 Copilot 代码审查。请参阅 没有 Copilot 许可证的组织成员的 Copilot 代码审查

使用 Copilot 代码审查

本说明解释如何在 GitHub 网站上使用 Copilot 代码审查。若需查看其他流行编码环境的说明,请点击页面顶部相应的标签。

  1. 在 GitHub.com 上,创建一个拉取请求(pull request),或转到已有的拉取请求。

  2. 打开 Reviewers 菜单,然后选择 Copilot

    Screenshot of selecting 'Copilot' from the 'Reviewers' menu.

  3. 等待 Copilot 审查你的拉取请求。通常不到 30 秒。

  4. 向下滚动并阅读 Copilot 的评论。

    Screenshot of a code review left by Copilot.

    Copilot 始终留下 “Comment(评论)” 类型的审查,而不是 “Approve(批准)” 或 “Request changes(请求更改)”。这意味着 Copilot 的审查不计入拉取请求的必需批准,也不会阻止合并更改。更多详情,请参阅 使用必需审查批准拉取请求

  5. Copilot 的审查评论行为与人为审查评论相同。你可以对其添加回应、发表评论、解决或隐藏它们。

    你对 Copilot 审查评论添加的任何评论对人可见,但对 Copilot 不可见,且 Copilot 不会回复。

使用 Copilot 提供的建议更改

在可能的情况下,Copilot 的反馈会包括建议的更改,你只需点击几下即可应用。

如果你对更改满意,可以接受单个 Copilot 建议并提交,或一次接受一组建议并在一次提交中完成。更多信息,请参阅 在拉取请求中合并反馈

你还可以调用 Copilot 云代理来实现建议的更改。为此,你必须

  • 选择加入 Copilot 代码审查工具的公开预览并启用 Copilot 云代理。
  • 在 GitHub Copilot 代码审查的评论上,点击 Implement suggestion。这会在拉取请求上创建一个草稿评论,你可以在其中指示 Copilot 处理特定反馈。Copilot 将基于这些建议在你的分支上创建一个新的拉取请求。

对 Copilot 的审查提供反馈

你可以在每条评论中直接对 Copilot 的评论提供反馈。我们会利用这些信息来改进产品和 Copilot 建议的质量。

  1. 在 Copilot 的拉取请求审查评论上,点击点赞 (👍) 或点讽 (👎) 按钮。

    Screenshot showing a Copilot code review comment with the thumbs up and thumbs down buttons.

  2. 如果您点击反对按钮,系统会要求您提供更多信息。您可以选择负面反馈的原因并在点击 提交反馈 前留下评论(此步骤为可选)。

    Screenshot of the form for providing additional information when you give negative feedback on a comment from Copilot.

请求 Copilot 重新审查

当你向已被 Copilot 审查的拉取请求推送更改时,Copilot 不会自动重新审查这些更改。

要请求 Copilot 重新审查,请点击在 Reviewers(审阅者)菜单中 Copilot 名称旁的按钮。更多信息,请参阅 请求拉取请求审查

注意

在重新审查拉取请求时,Copilot 可能会再次重复相同的评论,即使这些评论已通过 “Resolve conversation(解决对话)” 按钮被忽略或通过点讽 (👎) 按钮被降级。

启用自动审查

默认情况下,你需要像请求人工审查一样手动请求 Copilot 对每个拉取请求进行审查。然而,你可以设置 Copilot 自动审查所有拉取请求。请参阅 通过 GitHub Copilot 配置自动代码审查

使用自定义指令定制 Copilot 的审查

你可以通过向仓库添加自定义指令来定制 Copilot 代码审查。

仓库自定义指令可以是整个仓库范围的,也可以是特定路径的。你可以在仓库的 .github/copilot-instructions.md 文件中指定全局自定义指令。该文件可用于存放你希望 Copilot 在审查仓库中任意位置代码时考虑的信息。

你也可以编写仅在审查匹配指定路径的文件时使用的指令。将这些指令写入一个或多个 .github/instructions/**/*.instructions.md 文件中。

更多信息,请参阅 为 GitHub Copilot 添加仓库自定义指令

注意

  • Copilot 代码审查仅读取任何自定义指令文件的前 4,000 个字符。超出此限制的任何指令都不会影响 Copilot 代码审查生成的审查。此限制不适用于 Copilot Chat 或 Copilot 云代理。
  • 审查拉取请求时,Copilot 使用拉取请求基础分支中的自定义指令。例如,如果您的拉取请求旨在将 my-feature-branch 合并到 main 中,则 Copilot 将使用 main 中的自定义指令。

示例

以下是一个 .github/copilot-instructions.md 文件的示例,包含三条指令,这些指令将应用于仓库中所有 Copilot 代码审查。

When performing a code review, respond in Spanish.

When performing a code review, apply the checks in the `/security/security-checklist.md` file.

When performing a code review, focus on readability and avoid nested ternary operators.

审查代码选段

你可以在 Visual Studio Code 中请求对选中的代码片段进行初步审查。

  1. 在 Visual Studio Code 中,选中你想审查的代码。
  2. 右键单击所选代码,选择 Generate Code > Review
  3. VS Code 会在 Comments 面板中创建审查评论,并在编辑器中内联显示。

审查所有未提交的更改

你可以在 Visual Studio Code 中请求审查未提交的更改。

  1. 在 VS Code 中,点击活动栏中的 Source Control 按钮。

  2. Source Control 视图顶部,将鼠标悬停在 CHANGES 上,然后点击 Copilot Code Review - Uncommitted Changes 按钮。

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

  3. 等待 Copilot 审查你的更改。通常不到 30 秒。

  4. 如果 Copilot 有任何评论,它们会在你的文件内联显示,并出现在 Problems 选项卡中。

使用 Copilot 提供的建议更改

在可能的情况下,Copilot 的反馈会包含建议的更改,你只需单击一次即可应用。

Screenshot of a comment from Copilot in Visual Studio Code with a suggested change.

如果你对更改满意,可以点击 Apply and Go To Next 按钮接受 Copilot 的建议。你应用的任何更改都不会自动提交。

如果你不想应用 Copilot 的建议更改,点击 Discard and Go to Next 按钮。

对 Copilot 的审查提供反馈

你可以在每条评论中直接对 Copilot 的评论提供反馈。我们会利用这些信息来改进产品和 Copilot 建议的质量。

要提供反馈,将鼠标悬停在评论上并点击点赞或点讽按钮。

Screenshot of a comment from Copilot in Visual Studio Code with feedback buttons displayed. The buttons are outlined in dark orange.

使用自定义指令定制 Copilot 的审查

你可以通过向仓库添加自定义指令来定制 Copilot 代码审查。

仓库自定义指令可以是整个仓库范围的,也可以是特定路径的。你可以在仓库的 .github/copilot-instructions.md 文件中指定全局自定义指令。该文件可用于存放你希望 Copilot 在审查仓库中任意位置代码时考虑的信息。

你也可以编写仅在审查匹配指定路径的文件时使用的指令。将这些指令写入一个或多个 .github/instructions/**/*.instructions.md 文件中。

更多信息,请参阅 为 GitHub Copilot 添加仓库自定义指令

注意

  • Copilot 代码审查仅读取任何自定义指令文件的前 4,000 个字符。超出此限制的任何指令都不会影响 Copilot 代码审查生成的审查。此限制不适用于 Copilot Chat 或 Copilot 云代理。
  • 审查拉取请求时,Copilot 使用拉取请求基础分支中的自定义指令。例如,如果您的拉取请求旨在将 my-feature-branch 合并到 main 中,则 Copilot 将使用 main 中的自定义指令。

示例

以下是一个 .github/copilot-instructions.md 文件的示例,包含三条指令,这些指令将应用于仓库中所有 Copilot 代码审查。

When performing a code review, respond in Spanish.

When performing a code review, apply the checks in the `/security/security-checklist.md` file.

When performing a code review, focus on readability and avoid nested ternary operators.

先决条件

要使用 Copilot 代码审查,你必须使用 Visual Studio 17.14 版或更高版本。请参阅 Visual Studio 下载页面

使用 Copilot 代码审查

本说明解释如何在 Visual Studio 中使用 Copilot 代码审查。若需查看其他流行编码环境的说明,请点击页面顶部相应的标签。

  1. Git Changes 窗口中,点击 Review changes with Copilot。此按钮显示为带星光的评论图标。

  2. Copilot 将开始审查你的更改。几秒后,Git Changes 窗口中会出现显示代码审查评论数量的链接。

  3. 点击该链接查看并浏览评论。如果未发现问题,你会看到以下信息:Copilot 对任何文件均未发表评论。

  4. Copilot 在代码中显示评论,并提供每个潜在问题的摘要。你可以

    • 审查并根据建议进行更改。
    • 使用评论框右上角的向下箭头来忽略评论。
  5. 要移除所有审查评论,点击Git Changes 窗口中代码审查链接旁的按钮。

有关在 Visual Studio 中启用和配置 Copilot 代码审查的更多信息,请参阅 Visual Studio 文档中的 使用 Copilot Chat 审查本地更改

使用 Copilot 代码审查

本说明解释如何在 GitHub Mobile 中使用 Copilot 代码审查。若需查看其他流行编码环境的说明,请点击页面顶部相应的标签。

  1. 在 GitHub Mobile 中,打开一个拉取请求。
  2. 向下滚动至 Reviews 部分并展开。
  3. 点击 Request Reviews
  4. 将 Copilot 添加为审阅者,然后点击 Done

Copilot 将审查更改并提供反馈。

先决条件

要在 Xcode 中使用 Copilot 代码审查,你必须使用 0.41.0 或更高版本的 GitHub Copilot Chat 扩展。请从 github/CopilotForXcode 仓库 下载最新发布版本。

使用 Copilot 代码审查

本说明解释如何在 Xcode 中使用 Copilot 代码审查。若需查看其他流行编码环境的说明,请点击页面顶部相应的标签。

  1. 在 Xcode 中,对一个或多个文件进行更改。

  2. 通过点击菜单栏的 Editor,然后点击 GitHub Copilot 再选择 Open Chat,打开 Copilot 聊天窗口。

  3. 在 Copilot 聊天窗口提示框的右下角,点击 Code Review 按钮(气泡图标)。

    Screenshot of the Copilot chat window in Xcode, with the 'Code Review' button outlined in dark orange.

  4. 点击 Review Staged ChangesReview Unstaged Changes

  5. 聊天窗口会显示包含更改的文件列表。勾选复选框以取消选择你不希望 Copilot 审查的文件。

  6. 点击 Continue 开始审查过程。

  7. 如果 Copilot 发现需要评论的内容,它会在聊天窗口显示 Reviewed Changes 列表,列出已评论的文件。点击列表中的文件即可查看评论。

    每条评论都会以弹出窗口的形式显示,覆盖在编辑器之上。

    Screenshot of a Copilot code review review comment.

  8. 如果文件中有多个评论,可使用弹出窗口右上角的上下箭头在评论之间切换。

  9. Copilot 可能会建议替换代码。你可以点击 Accept 应用建议,或点击 Dismiss 拒绝。

  10. 在聊天窗口的 Reviewed Changes 列表中点击另一个文件,以查看该文件的审查评论。

先决条件

  • 拥有 Copilot 访问权限。请参阅 什么是 GitHub Copilot?

  • 兼容的 JetBrains IDE。要在 JetBrains 中使用 GitHub Copilot,你必须安装兼容的 JetBrains IDE。GitHub Copilot 与以下 IDE 兼容

    • IntelliJ IDEA (Ultimate, Community, Educational)
    • Android Studio
    • AppCode
    • CLion
    • Code With Me Guest
    • DataGrip
    • DataSpell
    • GoLand
    • JetBrains Client
    • MPS
    • PhpStorm
    • PyCharm (Professional, Community, Educational)
    • Rider
    • RubyMine
    • RustRover
    • WebStorm
    • Writerside

    请参阅 JetBrains IDEs 工具查找器进行下载。

  • 最新版本的 GitHub Copilot 扩展。请参阅 JetBrains Marketplace 中的 GitHub Copilot 插件。有关安装说明,请参阅 在您的环境中安装 GitHub Copilot 扩展

  • 在 JetBrains IDE 中登录 GitHub。有关身份验证说明,请参阅 在您的环境中安装 GitHub Copilot 扩展

使用 Copilot 代码审查

本说明解释如何在 JetBrains IDE 中使用 Copilot 代码审查。若需查看其他流行编码环境的说明,请点击页面顶部相应的标签。

  1. 在 JetBrains IDE 中,对一个或多个文件进行更改。

  2. 打开左侧的 “Commit” 工具窗口。

  3. 在提交信息输入框上方,点击 Copilot: Review Code Changes。此按钮显示为带星光的放大镜图标。

  4. Copilot 将开始审查你的更改。

  5. Copilot 在代码中显示评论,并提供每个潜在问题的摘要。你可以

    • 审查并根据建议进行更改。
    • 点击 Discard 以忽略评论。
  6. 如果有多个评论,可使用弹出窗口右上角的上下箭头在评论之间切换。

© . This site is unofficial and not affiliated with GitHub, Inc.