google工程实践文档

阅读本文大概需要 2 分钟

前几天，谷歌在GitHub上开源了他们的《谷歌工程实践文档（Google Engineering Practices Documentation）》。（回复：gepd 获得文档github地址）

目前，仓库里只更新了《谷歌的代码评审指南（Google's Code Review Guidelines）》，未来肯定不止于此，按照谷歌的规划，会陆续更新其他方面的最佳实践。以下是内容介绍，后面我会对这份文档进行翻译，全部发布在我的公众号里。

Google具有许多涵盖所有语言和所有项目的通用工程实践。这些文档代表了我们随着时间的推移积累的各种最佳实践的集体经验。开源项目或其他组织可能会从此知识中受益，因此我们致力于在可能的情况下将其公开提供。

当前，它包含以下文档：

Google的《代码审查指南》，实际上是两组独立的文档：

• 代码审阅者指南
• 变更作者指南

术语

这些文档中有一些使用Google内部术语，我们在此向外部读者阐明这些术语：

• CL：代表“变更列表”，表示一个已包含到版本控制中或正在进行代码审查的自包含更改。其他组织通常将其称为“更改”或“补丁”。
• LGTM：意思是“对我好”。这是代码审查者在批准CL时所说的。

代码审查指南

如何进行代码审查基于长期的经验，本节中的页面包含有关进行代码审查的最佳方法的建议。它们共同代表一个完整的文档，分为许多单独的部分。您不必全部阅读，但许多人发现阅读整本书籍对自己和团队非常有帮助。

• 代码审查标准
• 在代码审查中寻找什么
• 导航评论中的CL
• 代码审查速度
• 如何编写代码评论注释
• 在代码审查中处理推回

CL作者指南

本节中的页面包含针对开发人员进行代码审查的最佳实践。这些准则应有助于您更快地通过评论并获得更高质量的结果。您不必全部阅读它们，但是它们旨在适用于每位Google开发人员，而且许多人发现阅读整套内容很有帮助。

• 编写良好的CL描述
• 小CL
• 如何处理审阅者评论

里面内容很多，很具有指导意义，我准备在接下来的2个月内，对这份文档进行翻译，后续会把翻译同步到github，到时会在这里写上地址，欢迎指正。