简介
GitHub Copilot 可以审查代码并提供反馈。 如果可能,Copilot 的反馈会包括建议的更改,单击几次即可应用这些更改。
有关 GitHub Copilot代码审核 的完整简介,请参阅“关于 GitHub Copilot 的代码审查”。
当企业管理员或组织所有者启用该功能时,Copilot代码审查 也可供未持有 Copilot 许可证的组织成员使用。 请参阅面向未持有 Copilot 许可证的组织成员的 Copilot代码审查。
使用 Copilot代码审查
这些说明介绍如何在 GitHub 网站中使用 Copilot代码审查。 若要查看其他常用编码环境的说明,请单击页面顶部的相应选项卡。
-
在 GitHub.com 上,创建拉取请求或导航到现有拉取请求。
-
打开审查者菜单,然后选择 Copilot。

-
等待 Copilot 审查您的拉取请求。 这通常会在 30 秒内完成。
-
向下滚动并通读 Copilot 的注释。

Copilot 始终保留“注释”评审,而不是“批准”评审或“请求更改”评审。 这意味着 Copilot 的评审不计入拉取请求所需的批准,并且 Copilot 的评审也不会阻止合并更改。 有关详细信息,请参阅“批准需要审查的拉取请求”。
-
Copilot 的评审注释与人工评审的注释相同。 您可以为这些注释添加回应、进行评论,以及解决或隐藏它们。
您添加到 Copilot 的评审注释的任何评论将对人类可见,但这些评论对 Copilot 不可见,且 Copilot 不会回复。
处理 Copilot 提供的建议的更改
如果可能,Copilot 的反馈会包括建议的更改,单击几次即可应用这些更改。
如果您对更改感到满意,则可以接受来自 Copilot 中的单个建议并提交,也可以接受单个提交中的一组建议。 有关详细信息,请参阅“在拉取请求中加入反馈”。
您还可以调用 Copilot编程助理 来实现建议的更改。 为此,你必须:
- 选择加入 Copilot代码评审中的工具 的 公共预览版,并启用 Copilot编程助理。
- 在查看来自 GitHub Copilot代码审核 的评论时,单击实施建议。 这会针对拉取请求创建草稿注释,您可以在拉取请求中指示 Copilot 解决特定反馈。 Copilot将针对您的分支创建一个新的拉取请求,并应用建议。
为 Copilot 的评审提供反馈
您可以直接在每个注释中对 Copilot 的注释提供反馈。 我们将利用此信息来改进产品和 Copilot 提供的建议质量。
-
在 Copilot 的拉取请求审查注释中,单击拇指向上 (👍) 或拇指向下 (👎) 按钮。

-
如果单击拇指向下按钮,系统会要求你提供其他信息。 (可选)可以选择给出负面反馈的原因并留下评论,然后再点击“提交反馈”****。

请求 Copilot 重新评审
将更改推送到 Copilot 已评审的拉取请求时,它不会自动重新评审更改。
若要要请求 Copilot 重新评审,请单击审查者菜单中 Copilot 名称旁边的 按钮。 有关详细信息,请参阅“请求拉取请求审查”。
注意
重新评审拉取请求时,Copilot 可能会再次重复给出相同的注释,即使这些注释已通过“解决对话”按钮消除或者用拇指向下 (👎) 按钮表示了反对。
启用自动评审
默认情况下,需要手动请求 Copilot 对每个拉取请求的评审,与向人工请求评审一样。 但可以将 Copilot 设置为自动评审所有拉取请求。 请参阅“通过 GitHub Copilot 配置自动代码评审”。
使用自定义指令自定义 Copilot 的评审
您可以通过向存储库添加自定义说明来定制 Copilot代码审查。
存储库自定义说明可以是存储库范围的,也可以是特定于路径的。 您可以在存储库的 .github/copilot-instructions.md 文件中指定整个存储库的自定义指令。 可以使用此文件存储希望 Copilot 在存储库中的任何位置查看代码时考虑的信息。
你也可以编写 Copilot 仅在查看与指定路径匹配的文件中的代码时使用的说明。 在一个或多个 .github/instructions/**/*.instructions.md 文件中编写这些说明。
有关详细信息,请参阅“为GitHub Copilot添加存储库自定义说明”。
注意
- 数据变量.copilot.copilot_code-review_short %} 该系统仅读取任何自定义指令文件的前 4,000 个字符。 任何超出此限制的指令都不会影响由 Copilot代码审查 生成的评审。 此限制不适用于 Copilot对话 或 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 中突出显示的选定代码进行初始评审。
- 在 Visual Studio Code 中,选择要评审的代码。
- 右键单击所选代码,然后选择 “生成代码 > 评审”。
- VS Code 在 “评论” 面板中创建审阅评论,并在编辑器中内联显示它们。
评审所有未提交的更改
可以请求评审 Visual Studio Code 中未提交的更改。
-
在 VS Code 中,单击活动栏中的“Source Control”图标****。
-
在“Source Control”视图的顶部,将鼠标悬停在“CHANGES”上,然后单击 “Copilot Code Review - Uncommitted Changes”按钮************。

-
等待 Copilot 评审更改。 这通常会在 30 秒内完成。
-
如果 Copilot 有任何注释,它们将以内嵌方式显示在文件中和“问题”选项卡中****。
处理 Copilot 提供的建议的更改
在可能的情况下,Copilot 的反馈包括建议的更改,单击一次即可应用这些更改。

如果您对当前更改感到满意,可以通过单击应用并转到下一更改按钮,接受来自 Copilot 的建议。 您应用的任何更改都不会自动提交。
如果您不想应用 Copilot 的建议的更改,请单击放弃并转到下一更改按钮。
为 Copilot 的评审提供反馈
您可以直接在每个注释中对 Copilot 的注释提供反馈。 我们将利用此信息来改进产品和 Copilot 提供的建议质量。
若要提供反馈,请将光标悬停在注释上,然后单击拇指向上或拇指向下按钮。

使用自定义指令自定义 Copilot 的评审
您可以通过向存储库添加自定义说明来定制 Copilot代码审查。
存储库自定义说明可以是存储库范围的,也可以是特定于路径的。 您可以在存储库的 .github/copilot-instructions.md 文件中指定整个存储库的自定义指令。 可以使用此文件存储希望 Copilot 在存储库中的任何位置查看代码时考虑的信息。
你也可以编写 Copilot 仅在查看与指定路径匹配的文件中的代码时使用的说明。 在一个或多个 .github/instructions/**/*.instructions.md 文件中编写这些说明。
有关详细信息,请参阅“为GitHub Copilot添加存储库自定义说明”。
注意
- 数据变量.copilot.copilot_code-review_short %} 该系统仅读取任何自定义指令文件的前 4,000 个字符。 任何超出此限制的指令都不会影响由 Copilot代码审查 生成的评审。 此限制不适用于 Copilot对话 或 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代码审查。 若要查看其他常用编码环境的说明,请单击页面顶部的相应选项卡。
-
在“Git Changes”窗口中,单击“Review changes with Copilot”****。 此按钮显示为带有火花效果的注释图标。
-
Copilot 将查看你的更改。 片刻之后,“Git Changes”窗口中将显示一个包含代码评审注释数量的链接。
-
单击该链接可查看并定位注释。 如果未发现问题,您将看到如下提示信息:Copilot 未对任何文件添加注释。
-
Copilot 在代码中显示注释,其中包含每个潜在议题的摘要。 你可以:
- 根据建议查看并进行更改。
- 使用注释框右上角的向下箭头消除注释。
-
要删除所有评审注释,请单击“Git Changes”窗口中代码评审链接旁边的 。
有关在 Visual Studio 中启用和配置 Copilot代码审查 的更多信息,请参阅 Visual Studio 文档中的使用 Copilot对话 查看本地更改。
使用 Copilot代码审查
这些说明介绍如何在 GitHub Mobile 中使用 Copilot代码审查。 若要查看其他常用编码环境的说明,请单击页面顶部的相应选项卡。
- 在 GitHub Mobile 中,打开一个拉取请求。
- 向下滚动到“Reviews”部分并将其展开****。
- 单击“Request Reviews”****。
- 添加 Copilot 作为审阅者,然后单击“Done”****。
Copilot 将评审更改并提供反馈。
先决条件
若要在 Xcode 中使用 Copilot代码审查,需要使用 0.41.0 版本或更高版本的 GitHub Copilot 聊天 扩展。 从 github/CopilotForXcode 存储库下载最新版本。
使用 Copilot代码审查
这些说明介绍如何在 Xcode 中使用 。 若要查看其他常用编码环境的说明,请单击页面顶部的相应选项卡。
-
在 Xcode 中,对一个或多个文件进行一些更改。
-
** ** ** ** ** **通过单击菜单栏中的“Editor”、单击 GitHub Copilot 然后单击“Open Chat”,打开 Copilot 聊天窗口。 -
** **在 Copilot 聊天窗口的提示框右下角附近,单击“Code Review”按钮(语音气泡图标)。
-
** ** ** **单击“Review Staged Changes”或“Review Unstaged Changes”。 -
聊天窗口中显示包含更改的文件的列表。 单击复选框以取消选择不希望 Copilot 审阅的任何文件。
-
** **单击“Continue”以启动审阅过程。 -
** **如果 Copilot 找到要注释的内容,会在聊天窗口中显示“Reviewed Changes”列表,其中列出了已注释的文件。 单击此列表中的文件以查看注释。每个注释都显示在一个弹出窗口中,并覆盖在编辑器上。

-
如果文件中有多个注释,可使用弹出窗口右上角的向上和向下箭头在注释之间导航。
-
Copilot 可能会建议替换代码。 ** ** ** **可以通过单击“Accept”应用建议的更改或单击“Dismiss”拒绝更改。
-
** **单击聊天窗口中“Reviewed Changes”列表中的另一个文件,查看另一个文件的审阅注释。
Prerequisites
-
**对 Copilot 的访问权限**。 请参阅“[AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot#getting-access-to-copilot)”。 -
**兼容的 JetBrains IDE**。 若要在 JetBrains 中使用 GitHub Copilot,必须安装兼容的 JetBrains IDE。 GitHub Copilot 与以下 IDE 兼容:- IntelliJ IDEA(旗舰版、社区版、教育版)
- Android Studio
- AppCode
- CLion
- Code With Me 来宾
- DataGrip
- DataSpell
- GoLand
- JetBrains 客户端
- MPS
- PhpStorm
- PyCharm(专业版、社区版、教育版)
- Rider
- RubyMine
- RustRover
- WebStorm
- Writerside
请参阅 JetBrains IDE 工具查找器进行下载。
-
最新版本的 GitHub Copilot 扩展****。 请参阅 JetBrains Marketplace 中的 GitHub Copilot 插件。 有关安装说明,请参阅“在环境中安装 GitHub Copilot 扩展”。
-
在 JetBrains IDE 中登录到 GitHub****。 有关身份验证说明,请参阅“在环境中安装 GitHub Copilot 扩展”。
使用 Copilot代码审查
这些说明介绍如何在 JetBrains IDE 中使用 。 若要查看其他常用编码环境的说明,请单击页面顶部的相应选项卡。
-
在 JetBrains IDE 中,对一个或多个文件进行一些更改。
-
打开左侧的“Commit”工具窗口。
-
在提交消息输入字段上方,单击“Copilot: Review Code Changes”****。 此按钮显示为带有火花效果的放大镜图标。
-
Copilot 将查看你的更改。
-
Copilot 在代码中显示注释,其中包含每个潜在议题的摘要。 你可以:
- 根据建议查看并进行更改。
- 通过单击“Discard”消除注释****。
-
如果有多个注释,可使用弹出窗口右上角的向上和向下箭头在注释之间导航。