《Software Engineering at Google》 原文: Software Engineering at Google (abseil.io)
章节:Critique: Google’s Code Review Tool
谷歌的Critique工具在他们公司内部很受欢迎,开发者满意度高达 97%。虽然Critique没有开源,我们总结它的优秀经验,结合公司的研发特点,可以基于开源的Gerrit定制开发优秀的Code-Review工具。
1. Code-Review工具的设计原则
(1)简洁性
Critique的用户界面(UI)的设计理念是使代码审查变得简单易行,避免了许多不必要的选择,并且界面流畅。UI加载速度快,导航简便并支持热键操作,而且对于更改是否已审查的总体状态有清晰的视觉标记。
(2)信任的基础
代码审查不是为了拖慢别人的步伐;相反,它是为了赋予他人能力。尽可能地信任同事是使其工作的关键。例如,这可能意味着信任代码作者的修改,而不需要一个额外的审查阶段来二次检查那些小的评论是否真的被解决了。通过使更改公开可访问(供查看和审查),在整个谷歌范围内,信任也得以体现。
(3)通用沟通
沟通问题很少通过工具解决。Critique优先考虑用户对代码变更进行评论的通用方式,而不是复杂的协议。Critique鼓励用户在他们的评论中明确表达他们想要什么,甚至建议一些编辑,而不是使数据模型和过程更加复杂。即使有了最好的代码审查工具, 沟通也可能出错,因为用户是人类。
(4)工作流程集成
Critique与其他核心软件开发工具有许多集成点。开发人员可以通过代码搜索和浏览工具轻松地导航查看正在审查的代码,使用我们的基于Web的代码编辑工具编辑代码,或查看与代码变更相关联的测试结果。