How to Code Review Using GitHub
3 招提高 GitHub 代码审查效率
前言
如今 Git 与 GitHub 已经成为业界主流,有很大概率你的项目也会使用到它们进行版本控制,这篇文章主要探讨 GitHub 网页版上其实有许多内建功能可以提高代码审查的效率值得去了解。
由于 GitHub 是一款基于 Git 附加的服务,所以我们时常会轻视它的功能,但其实 GitHub 有许多不错的功能却不是那么明显,因此主要分享一些我认为有用但日常使用没有察觉到的功能。
第一招:提交审核的方式
不知道你有没有想过每次 GitHub 审查时 “Add single comment” 与 “Start a review” 究竟差别在哪儿吗?如果没有特别翻查过文件还真的不知道这两个按钮用途差在哪,不都是提交审核吗?
原来差别主要在于使用情境,如果你确定只有一则审核要提交那么 Add single comment 就十分方便,但如果有多则审核要提交那么最好选择 Start a review 可以一次评论完再提交。
- Add single comment:快速提交一则评论。
- Start a review:添加多则评论,评论完再点击 Finish your review 按钮提交。
为什么不能一则一则提交呢?因为每一次提交就会通知(甚至发邮件)给整个关注这则 PR 的人,如果审核的项目多或时间长,频繁的通知还蛮恼人的。
第二招:代码建议
有时候你希望在审核中提供一些代码建议,就可以使用 Add a suggestion 功能(或是 ctrl + g
),就会出现一个 Markdown 的 Code Block,方便写下建议,并且切换成 Preview 时会自动显示与现有代码的交互比对。
审核者在阅读审核时除了得到更为具体的建议之外,也可以直接点击 Commit suggestion > Commit changes 按钮来直接套用建议。
第三招:多行审核
启动代码建议的 + 号按钮其实是可以拖曳的,这样就可以一次选取多行相关的代码进行审核。