使用 GitHub Copilot 代码评审

使用 Copilot 代码评审

这些说明介绍如何在 GitHub 网站中使用 Copilot 代码评审。 若要查看其他常用编码环境的说明，请单击页面顶部的相应选项卡。

1. 在 GitHub.com 上，创建拉取请求或导航到现有拉取请求。

2. 打开“审查者”菜单，然后选择“Copilot”********。

   

3. 等待 Copilot 审查拉取请求。 这通常会在 30 秒内完成。

4. 向下滚动并通读 Copilot 的注释。

   

   Copilot 始终保留“注释”评审，而不是“批准”评审或“请求更改”评审。 这意味着 Copilot 的评审不计入拉取请求所需的批准，并且 Copilot 的评审不会阻止合并更改。 有关详细信息，请参阅“批准需要审查的拉取请求”。

5. Copilot 的评审注释就像人工评审的注释一样。 你可以对这些注释添加回应、进行评论，以及解决或隐藏它们。

   添加到 Copilot 的评审注释的任何评论将对人类可见，但这些评论对 Copilot 不可见，Copilot 不会回复。

处理 Copilot 提供的建议的更改

如果可能，Copilot 的反馈会包括建议的更改，单击几次即可应用这些更改。

如果你对更改感到满意，则可以接受来自 Copilot 中的单个建议并提交，也可以接受单个提交中的一组建议。 有关详细信息，请参阅“在拉取请求中加入反馈”。

提供有关 Copilot 提供的评审的反馈

可以直接在每个注释中提供有关 Copilot 提供的注释的反馈。 我们将利用此信息来改进产品和 Copilot 提供的建议质量。

1. 在 Copilot 提供的拉取请求审查注释中，单击拇指向上 (👍) 或拇指向下 (👎) 按钮。

   

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

   

向 Copilot 请求重新评审

将更改推送到 Copilot 已评审的拉取请求时，它不会自动重新评审更改。

要向 Copilot 请求重新评审，请单击“审查者”菜单中 Copilot 的名称旁边的 按钮****。 有关详细信息，请参阅“请求拉取请求审查”。

启用自动评审

默认情况下，需要手动请求 Copilot 对每个拉取请求的评审，与向人工请求评审一样。 但可以将 Copilot 设置为自动评审所有拉取请求。 请参阅“配置 GitHub Copilot 的自动代码评审”。

使用自定义指令自定义 Copilot 的评审

可以通过向存储库添加自定义说明来自定义 Copilot 代码评审。

存储库自定义说明可以是存储库范围的，也可以是特定于路径的。 在存储库的 .github/copilot-instructions.md 文件中指定存储库范围的自定义说明。 可以使用此文件存储希望 Copilot 在存储库中的任何位置查看代码时考虑的信息。

你也可以编写 Copilot 仅在查看与指定路径匹配的文件中的代码时使用的说明。 在一个或多个 .github/instructions/NAME.instructions.md 文件中编写这些说明。

有关详细信息，请参阅“为 GitHub Copilot 添加存储库自定义说明”。

示例

以下是一个 .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.

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.