Lightweight "Code Review" with Git

介绍一种git环境下的“轻量级”的“code review”方法。 “code review”加上引号是因为它只能算“查看代码改动”的一种方式。 如果由于某些原因导致像Gerrit这样的专业code review工具不能用时,可以考虑一下它。

简单的步骤如下:

  • Reviewee把代码改动输出到一个文件里。
  • 把上一步生成的文件发给reviewer。
  • Reviewer进行code review。

Reviewee

如果reviewee已经把代码改动提交到本地仓库, 假设commit的SHA-1是e3fbbbcfd(如果commit是最新的提交,那么e3fbbbcfd也可以用HEAD替代),

$ git show e3fbbbcfd --color > change-to-review

假设代码改动还没有提交,

$ git diff --color -- path/to/file-to-review-1 path/to/file-to-review-2 > change-to-review

--color选项会用颜色高亮代码的改动。

Reviewee通过邮件或者聊天工具等方式把change-to-review文件发给reviewer。

Reviewer

Reviewer检查代码改动,

$ cat change-to-review | less -R

-R选项使less可以显示颜色。

less -R

还可以用diff-highlight来进一步高亮代码改动,方便review代码。 下载diff-highlight脚本,放到系统的PATH目录下。然后运行如下命令,

$ cat change-to-review | diff-highlight | less -R

效果如图,

diff-highlight
2016-06-15 08:36
推荐到豆瓣

如果你觉得这篇文章对你有用,可以微信扫一扫表示🙏 / If you find this post is useful to you, buy me 🍶 via Wechat