拉取请求审查是团队及早发现问题并保持较高代码质量的一种方式。 本快速入门指南将逐步介绍评审所需的各个主要工具:
- 对代码的注释
- 提出具体修改建议
- 提交您的审核意见,并批准或请求修改
对更改发表评论
对存储库具有读取访问权限的任何人都可以查看和注释拉取请求。
- 在 GitHub 上,转到拉取请求。
- 通读拉取请求摘要以及任何相关评论或问题,以了解审阅所需的上下文。
- 单击“已更改的文件”选项卡。
- 将鼠标悬停在要批注的行上,然后单击 。 若要对多行进行批注,请单击并拖动以选择它们。
- 键入批注,然后单击“ 开始审阅 ”以将其保存为待定状态,直到完成审阅。 待处理评论在你提交审核之前仅对你可见。
提出代码建议
当你知道你想要的确切更改时,建议它,以便作者可以一键应用它。
- 在“已更改的文件”选项卡上,在要更改的一行或多行上发起评论。
- 在批注工具栏中,单击 以插入建议块,然后编辑其中的代码以显示建议的更改。
- 单击“ 开始审阅 ”或 “添加审阅批注 ”以在评论中包含建议。
提交评论
通过提交评论完成并做出一个决定,告知作者接下来该怎么做。
-
单击“ 查看更改”。
-
添加摘要注释。
-
选择决定,然后单击 “提交评审” :
- 注释 会留下反馈,而无需明确批准或请求更改。
- 批准表示这些更改已准备好合并。
- 请求更改会将作者在合并前必须处理的反馈标记出来。