google_eng_practice

Google Engineering Practice Documentation

Google has many excellent engineering practices that cover almost all programming languages ​​in the company. As the number of development projects increases, we continue to summarize experience and organize these best practices in the form of documents. Now that the document is becoming more mature, we have decided to release it publicly so that other companies, organizations or open source projects can benefit from it.

The content of this engineering practice document is as follows:

• Google Code Review Guide, which contains two parts:
  • Code Reviewer Guide
  • Code Submitter Guide

the term

In the documentation, some internal Google terms are used. To avoid misunderstandings, we will explain it briefly:

• CL : That is, "changelist", which can be translated into a modification list in Chinese. It is a code modification submitted to the version control tool (the code to be reviewed soon). Some companies or organizations call it "change" or "patch".
• LGTM : The abbreviation of “Looks Good to Me.”, “Looks Good to Me.” When an auditor says this, it means he will approve the CL.
• g3doc : Google's internal engineering documentation platform.

Version

The original English text comes from Google's Engineering Practices documentation, and the Chinese version is translated and compiled by zijinshi. According to Chinese expression habits, there are a small number of modifications based on the original text.

Version	date	illustrate
1.0	2019.10.07	The initial version is completed
1.1	2019.10.18	Fix some inaccurate translations
1.2	2020.01.02	Where the modification sentence is not smooth and the translation word is inconsistent
1.3	2024.04.26	Based on the latest content of the English version, update the Chinese version

The Chinese version is also published on the website:

• Google Engineering Practice Documentation (Github)
• Google Engineering Practice Documentation (Gitbook)

Video learning:

• Google Engineering Practice Document Introduction

PDF version download:

• Google Engineering Practice Documentation

Some insights about Google code practice

License

This article complies with CC-By 3.0 License (Chinese version, English version).

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.