简介
GitHub Copilot 可以审查代码并提供反馈。 如果可能,Copilot 的反馈会包括建议的更改,单击几次即可应用这些更改。
有关 GitHub Copilot 代码评审 的完整简介,请参阅“关于 Copilot 代码评审”。
使用 Copilot 代码评审
这些说明介绍如何在 GitHub 网站中使用 Copilot 代码评审。 要查看其他常用编码环境的说明,请使用页面顶部的工具切换器。
-
在 GitHub.com 上,创建拉取请求或导航到现有拉取请求。
-
打开“审查者”菜单,然后选择“Copilot”********。
-
等待 Copilot 审查拉取请求。 这通常会在 30 秒内完成。
-
向下滚动并通读 Copilot 的注释。
Copilot 始终保留“注释”评审,而不是“批准”评审或“请求更改”评审。 这意味着 Copilot 的评审不计入拉取请求所需的批准,并且 Copilot 的评审不会阻止合并更改。 有关详细信息,请参阅“批准需要审查的拉取请求”。
-
Copilot 的评审注释就像人工评审的注释一样。 你可以对这些注释添加回应、进行评论,以及解决或隐藏它们。
添加到 Copilot 的评审注释的任何评论将对人类可见,但这些评论对 Copilot 不可见,Copilot 不会回复。
处理 Copilot 提供的建议的更改
如果可能,Copilot 的反馈会包括建议的更改,单击几次即可应用这些更改。
如果你对更改感到满意,则可以接受来自 Copilot 中的单个建议并提交,也可以接受单个提交中的一组建议。 有关详细信息,请参阅“在拉取请求中加入反馈”。
提供有关 Copilot 提供的评审的反馈
可以直接在每个注释中提供有关 Copilot 提供的注释的反馈。 我们将利用此信息来改进产品和 Copilot 提供的建议质量。
-
在 Copilot 提供的拉取请求审查注释中,单击拇指向上 (👍) 或拇指向下 (👎) 按钮。
-
如果单击拇指向下按钮,系统会要求你提供其他信息。 (可选)可以选择给出负面反馈的原因并留下评论,然后再点击“提交反馈”****。
向 Copilot 请求重新评审
将更改推送到 Copilot 已评审的拉取请求时,它不会自动重新评审更改。
要向 Copilot 请求重新评审,请单击“审查者”菜单中 Copilot 的名称旁边的 按钮****。 有关详细信息,请参阅“请求拉取请求审查”。
注意
重新评审拉取请求时,Copilot 可能会再次重复给出相同的注释,即使这些注释已通过“解决对话”按钮消除或者用拇指向下 (👎) 按钮表示了反对。
启用自动评审
默认情况下,需要手动请求 Copilot 对每个拉取请求的评审,与向人工请求评审一样。 但可以将 Copilot 设置为自动评审所有拉取请求。 请参阅“配置 Copilot 的自动代码评审”。
使用自定义指令自定义 Copilot 的评审
注意
Copilot 代码评审 的自定义指令目前处于公共预览版阶段,未来可能会有所变动。
在公共预览版期间,如果你使用 Copilot Business 或 Copilot Enterprise 计划,则为你提供计划的组织或企业必须已启用“Opt in to preview features”设置****。 请参阅“管理组织中的 Copilot 策略和功能”或“管理企业中 Copilot 的策略和功能”
可以通过在仓库中添加包含信息的 .github/copilot-instructions.md
文件来自定义 Copilot 代码评审,以便在 Copilot 评审代码时考虑这些信息。 此文件与 Copilot 对话助手 使用的 copilot-instructions.md
文件相同。 请参阅“为 GitHub Copilot 添加存储库自定义说明”。
示例
以下是一个 .github/copilot-instructions.md
文件的示例,其中包含三条指令,这些指令将应用于仓库中所有 Copilot 代码评审。
When performing a code review, respond in Spanish.
When performing a code review, follow our internal security checklist.
When performing a code review, focus on readability and avoid nested ternary operators.
使用编码准则对 Copilot 的评审进行自定义设置
注意
自定义编码准则功能仅适用于 Copilot Enterprise 计划,目前仅限选定客户使用。
此功能将被弃用,取而代之的是使用 Copilot 自定义指令来自定义 Copilot 代码评审。
使用 Copilot 代码评审 查看 Visual Studio Code 或 GitHub 网站中的更改时,可以使用以自然语言编写的自定义编码准则来自定义 Copilot 的评审。 Copilot 在评审代码时将根据编码准则提供反馈。 有关详细信息,请参阅“为 GitHub Copilot 代码评审配置编码准则”。
基于编码准则生成的注释将包含一条消息,并突出显示了其源。