9月6日,Google内部代码Code Review实践指南正式发布。该指南是Google内部代码实践的经验结晶。Google觉得这个经验应该对整个业界都有帮助,故而将其开源。该指南分为若干个章节,读者不必完整阅读,不过很多读过的工程师都感到受益匪浅。
该实践指南分为两个部分,一个针对代码提交者,另一个针对审查者。针对代码提交者的部分,分为三个章节:
写好代码修改的描述
提交小patch(频繁提交)
如何处理代码审核的评论
针对审核者的部分,分为六个章节:
代码审核标准
代码审核时该看些什么
浏览一个patch
代码审核的速度
如何写审核评论
如何处理审核后程序员拒绝修改的情况
单看这目录,小编就不得不感叹,这必然又是一部程序员必读的经典实践操作指南。
Google内部术语
CL:"chang list"的简称,跟我们通常所说的patch是一个意思。
LGTM:"Looks Good to Me",意思就是我OK的,我觉得这个patch可以通过审查了。
Google Code Review实践指南地址
https://google.github.io/eng-practices/
你也可以点击“阅读原文”查看
该指南遵循CC-By 3.0开源文档协议,有心的小伙伴可以clone该文档进行翻译,翻译完成后可以发邮件给小编,小编可以帮您宣传翻译后的成果,以便更好地帮助大家学习。小编的邮箱是:
shishusaiwai@freelycode.com
另外,小编也建议大家关注下Google在Github上的账号,上面有大约1600个Google的开源项目。开源力度如此的国内公司,怕是难以找到呢~ Google的Github账号地址是:
https://github.com/google