跳至主要内容

审查合并请求中建议的更改

在合并请求中,您可以审查和讨论提交、已更改的文件以及基本分支和比较分支中文件之间的差异(或“diff”)。

关于审查合并请求

您可以一次审查合并请求中的一个文件。在审查合并请求中的文件时,您可以在特定更改上留下单独的评论。在完成对每个文件的审查后,您可以将文件标记为已查看。这会折叠文件,帮助您识别仍需审查的文件。合并请求标题中的进度条显示您已查看的文件数。在审查完任意数量的文件后,您可以通过提交带有摘要评论的审查来批准合并请求或要求进行其他更改。

提示:您可以使用搜索限定符 review-requested:[USERNAME]team-review-requested:[TEAMNAME] 查找您或您所在的团队被请求审查的合并请求。有关详细信息,请参阅“搜索问题和合并请求”。

开始审查

  1. 在你的存储库名称下,单击 拉取请求.

    Screenshot of the main page of a repository. In the horizontal navigation bar, a tab, labeled "Pull requests," is outlined in dark orange.

  2. 在拉取请求列表中,单击你想要查看的拉取请求。

  3. 在拉取请求中,单击 已更改的文件.

    Screenshot of the tabs for a pull request. The "Files changed" tab is outlined in dark orange.
    你可以通过单击更改此选项卡中 diff 视图的格式 并选择统一或拆分视图。你在查看其他拉取请求的 diff 时,所做的选择将适用。

    Screenshot of the "Files changed" tab for a pull request. The "Diff view" menu is outlined in dark orange.

    你还可以选择隐藏空白差异。你所做的选择仅适用于此拉取请求,并且在你下次访问此页面时将被记住。

  4. 或者,筛选文件以仅显示你想要查看的文件,或使用文件树导航到特定文件。有关更多信息,请参阅“在拉取请求中筛选文件”。

  5. 将鼠标悬停在你想添加评论的代码行上,然后单击蓝色的评论图标。

    Screenshot of a diff in a pull request. Next to a line number, a blue plus icon is highlighted with an orange outline.

  6. 或者,你可以在多行上添加评论。你可以单击你想评论的第一行的行号,然后向下拖动以选择一系列行,然后单击你想评论的最后一行上的蓝色评论图标。或者,你可以单击你想评论的第一行旁边的蓝色评论图标,然后向下拖动到你想评论的最后一行。

  7. 在评论字段中,输入你的评论。

  8. 或者,要对行或多行建议特定更改,请单击 ,然后编辑建议块中的文本。

    Screenshot of a review comment box. The file diff icon to suggest a specific change is outlined in dark orange.

  9. 要直接对文件发表评论,请在文件的右侧单击 并输入你的评论。

    Screenshot of an image file on the "Files changed" page of a pull request. To the right of the image file, a comment icon is highlighted with an orange outline.

  10. 完成后,单击开始审核。如果你已经开始审核,则可以单击添加审核评论

在你提交审核之前,你的行评论为待定,并且仅对你可见。你可以在提交审核之前随时编辑待定评论。要取消待定审核(包括其所有待定评论),请单击已更改代码上方的审核更改,然后单击放弃审核

Screenshot of the comment field for a review. The "Abandon review" button is outlined in dark orange.

你可以使用 GitHub Codespaces 来测试、运行和审阅请求。

  1. 在 Codespace 中打开请求,如“使用 GitHub Codespaces 进行请求”中所述。

  2. 在活动栏中,单击GitHub 请求视图。此视图仅在你于 Codespace 中打开请求时出现。

    Screenshot of the VS Code Activity Bar. The mouse pointer is hovering over an icon displaying the tooltip "GitHub Pull Request."

  3. 要审阅特定文件,请单击侧栏中的打开文件图标。

    Screenshot of the "GitHub Pull Request" side bar. A file name is highlighted with a dark orange outline.

  4. 要添加审阅评论,请单击行号旁的+图标。输入你的审阅评论,然后单击开始审阅

    Screenshot of a comment being added, reading "Yes, I agree, this is clearer." The "Start Review" button is shown below the comment.

  5. 或者,你可以建议请求作者可以单击以提交的更改,如果他们同意你的建议。要执行此操作,请单击并按住你要建议更改的第一行旁的+号,然后将+号拖动到你要建议更改的最后一行。然后在显示的评论框中单击提出建议

    你选择的行将复制到评论框中,你可以在其中编辑它们以建议更改。你可以在包含```suggestion的行上方添加评论以解释你的建议更改。

    单击添加评论以将你的建议添加到请求中。

    Screenshot of a suggested change. The "Make a Suggestion" and "Add Comment" buttons are shown below the suggested change.

  6. 当你完成添加审阅评论后,你可以从侧栏中选择提交评论、批准更改或请求更改。

    Screenshot of the side bar showing the dropdown options "Comment and Submit," "Approve and Submit," and "Request Changes and Submit."

有关在 GitHub Codespaces 中审阅请求的更多信息,请参阅“使用 GitHub Codespaces 进行请求”。

审阅依赖项更改

如果请求包含对依赖项的更改,你可以使用清单或锁定文件的依赖项审阅来查看已更改的内容,并检查更改是否引入了安全漏洞。有关更多信息,请参阅“审阅请求中的依赖项更改”。

  1. 在拉取请求中,单击 已更改的文件.

    Screenshot of the tabs for a pull request. The "Files changed" tab is outlined in dark orange.

  2. 在清单或锁定文件的标题右侧,通过单击富差异按钮来显示依赖项审阅。

    Screenshot of the "Files changed" tab of a pull request. The button to display the rich diff, labeled with a file icon, is outlined in dark orange.

  3. 您可能还想查看源代码差异,因为清单或锁定文件中可能存在不会更改依赖项的更改,或者可能存在 GitHub 无法解析的依赖项,因此不会显示在依赖项审查中。

    要返回源代码差异视图,请单击 按钮。

    Screenshot of the "Files changed" tab of a pull request. The button to display the source diff, which is labeled with a code icon, is outlined in dark orange.

将文件标记为已查看

在完成对文件的审查后,您可以将文件标记为已查看,然后文件将折叠。如果在查看文件后文件发生更改,则该文件将取消标记为已查看。

  1. 在拉取请求中,单击 已更改的文件.

    Screenshot of the tabs for a pull request. The "Files changed" tab is outlined in dark orange.

  2. 在已完成审查的文件标题右侧,选择已查看

    Screenshot of the header of a file. The "Viewed" option is outlined in dark orange.

提交您的审查

在完成对拉取请求中所需的所有文件的审查后,提交您的审查。

  1. 在拉取请求中,单击 已更改的文件.

    Screenshot of the tabs for a pull request. The "Files changed" tab is outlined in dark orange.

  2. 在更改的代码上方,单击审查更改

    Screenshot of the "Files changed" tab of a pull request. The "Review changes" button is outlined in dark orange.

  3. 输入一条评论,总结您对提议更改的反馈。

  4. 选择您要留下的审查类型

    • 选择评论以留下一般反馈,而无需明确批准更改或要求其他更改。
    • 选择批准以提交您的反馈并批准合并拉取请求中提出的更改。
    • 选择请求更改以提交必须在合并拉取请求之前解决的反馈。
  5. 单击提交审查

提示:

  • 如果具有对存储库的adminownerwrite访问权限的合作者提交了请求更改的审查,则在同一合作者提交另一项审查以批准拉取请求中的更改之前,无法合并拉取请求。
  • 存储库所有者和管理员可以合并拉取请求,即使它没有收到批准审查,或者请求更改的审阅者已离开组织或不可用。
  • 如果启用了必需的审核和过时的审核驳回,并且将修改代码的提交推送到已批准的拉取请求的分支,则该批准将被驳回。必须再次审核并批准拉取请求,然后才能合并。
  • 当几个打开的拉取请求的头部分支都指向同一提交时,如果其中一个或两个有待处理或被拒绝的审核,则无法合并它们。
  • 如果你的存储库需要具有写入或管理员权限的人员批准审核,那么具有这些权限的人员的任何批准都将用绿色对勾标记表示,而没有这些权限的人员的批准则用灰色对勾标记表示。带有灰色对勾标记的批准不会影响拉取请求是否可以合并。
  • 拉取请求作者无法批准自己的拉取请求。

进一步阅读