# Google工程实践文档

Google有很多优秀的工程实践，这些实践遍布公司内的所有项目，覆盖了几乎所有编程语言。 随着开发项目的增多，我们不断总结经验，把这些最佳实践以文档的形式整理出来。现在文档日趋成熟，我们决定将其公开发布，让其他公司、组织或开源项目也能从中受益。

这份工程实践文档内容如下：

* [Google代码审核指南](/google/review.md)，它包含两部分：
  * [代码审核者指南](/google/index.md)
  * [代码提交者指南](/google/developer.md)

## 术语

在文档中，用到了一些 Google 内部术语，为避免误解，我们稍作解释：

* **CL**： 即“changelist”， 中文可以翻译成修改列表，它是提交到版本控制工具中的一次代码修改（即将审核的代码）。有的公司或组织称它为 “修改”(change)或“补丁”(patch)。
* **LGTM**： “Looks Good to Me.” 的缩写，“看起来不错”。 当一个审核者这么说的时候，意味着他会批准这个CL。
* **g3doc**： Google内部的工程文档平台。

## 版本

英文原文来自 [Google's Engineering Practices documentation](https://github.com/google/eng-practices)，中文版由 [zijinshi ](https://github.com/zijinshi)翻译整理。

| 版本  | 日期         | 说明                 |
| --- | ---------- | ------------------ |
| 1.0 | 2019.10.07 | 初版完成               |
| 1.1 | 2019.10.18 | 修复某些翻译不准确的地方       |
| 1.2 | 2020.01.02 | 修改语句不通顺、翻译用词不一致的地方 |
| 1.3 | 2024.04.26 | 基于英文版的最新内容，更新中文版   |

中文版同时发布于网站：

* [Google工程实践文档(Github)](https://zijinshi.github.io/google_eng_practice/index)
* [Google工程实践文档(Gitbook)](https://zijinshi.gitbook.io/google)

视频学习：

* [Google工程实践文档导读](https://edu.csdn.net/course/detail/26718)

PDF版本下载：

* [Google工程实践文档](https://github.com/zijinshi/google_eng_practice/raw/gitbook/Google%E5%B7%A5%E7%A8%8B%E5%AE%9E%E8%B7%B5%E6%96%87%E6%A1%A3.pdf)

[Google工程实践的一些感悟](/google/readme.md)

## License

本文遵守 CC-By 3.0 License（[中文版](https://creativecommons.org/licenses/by/3.0/deed.zh)、[英文版](https://creativecommons.org/licenses/by/3.0/)）。

The documents in this project are licensed under the CC-By 3.0 License, which encourages you to share these documents. See <https://creativecommons.org/licenses/by/3.0/> for more details.

[![Creative Commons License](https://i.creativecommons.org/l/by/3.0/88x31.png)](https://creativecommons.org/licenses/by/3.0/)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://zijinshi.gitbook.io/google/introduction.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.