跳到主要内容

代码审查

代码评审是一种协同工作方法,它允许团队成员审查、讨论和提供反馈,以确保代码的质量、可读性和安全性。通过代码评审,团队成员可以:

  • 审查代码质量:检查代码是否符合项目的标准和最佳实践
  • 提供反馈:发现潜在问题并提供改进建议
  • 验证功能:确保新功能或更改的正确性
  • 维护可读性:确保代码易于理解和维护

如何进行代码评审


  • 在项目页点击「Pull Requests」,选择要审查的Pull Request。

image-20241231163202702

审查者评论


审查者发布评论的常见步骤如下:

  1. 在PR审查页点击「讨论」滑至最下方可以发送评论。

image-20241231165146192

  1. 文件改动中,你可以单击行号或选中文本,然后单击右侧评论按钮来提出评论。在评论中,可以提供建议、问题和反馈或指出错误以改进代码。

image-20241231163901750

  1. 作者和评审人可以在评论中进行讨论,以解决问题或澄清疑虑。

image-20241231164545083

代码已阅


PullRequest 已阅功能可以为审查人员保存 PullRequest 变更代码的查看进度,有效分辨已查看和未查看的代码。

  1. 点击「文件改动」可以查看代码对比视图,点击右上角「已读」可以标记相应文件的查看状态。

image-20241231172737331

检查更改差异


使用代码对比视图来可以比较不同版本之间的代码的更改,查看代码更改的差异,了解哪些代码已添加、删除或修改。

  1. 选择「提交」后点击对应的提交可以查看这一提交的代码对比视图。

image-20241231173516402

  1. 点击「文件改动」同样可以查看代码对比视图。

image-20241231174811815

  1. 点击右上角可以选择文件展开/收起、代码显示设置、代码对比Diff模式、是否忽略代码中空格和换行符。

image-20241231173915983

批准或拒绝PR


点击上方「讨论」审查人可以处理PR,包括设为草稿、关闭、合入。

image-20241231175134932

设为草稿:

PR暂不会被合并,标题前会出现【WIP】,点击「准备就绪」可以取消草稿状态,点击「关闭」则可以关闭该PR。

image-20241231180352868

关闭PR

该PR不再需要被处理,同时也不会合并到主分支。

合入

提交的修改将会被合并入主分支。

代码审查是团队合作和持续改进的重要组成部分。通过有效的沟通和反馈,可以提升代码的质量和团队的协作效率。