eng-practices README

The project's README from github.com/google/eng-practices. As one markdown file: README.md.

Google Engineering Practices Documentation

Google has many generalized engineering practices that cover all languages and all projects. These documents represent our collective experience of various best practices that we have developed over time. It is possible that open source projects or other organizations would benefit from this knowledge, so we work to make it available publicly when possible.

Currently this contains the following documents:

Terminology

There is some Google-internal terminology used in some of these documents, which we clarify here for external readers:

License

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

eng-practices (google/eng-practices)

Searching Database…

23.3K ·GitHub
archived
这是做什么的?Google 的工程实践文档——一份公开的指南合集,提炼了 Google 在所有语言和项目中普遍采用的工程实践,目前主要聚焦于其代码审查指南(Code Review Guidelines)。
这是能运行的工具,还是只是文档?只是文档,没有可运行的代码。仓库里存放的是 Google 的代码审查指南,写成两份独立的指南:一份面向代码审查者,一份面向改动作者。
怎么阅读——需要安装什么吗?什么都不用装。这些指南就是仓库里的纯 markdown 文件,同时也发布在 GitHub Pages 上作为静态网站,直接用浏览器打开就能看。
这个项目还在活跃维护吗?没有。该仓库已归档并设为只读——指南仍然可以查看,但不再在这里更新了。
这些指南是写给谁看的?首先是写给 Google 工程师的——有些文档用了 Google 内部术语,比如 CL,README 会为外部读者解释这些词——不过公开出来也是为了让开源项目和其他组织同样受益。
我可以分享或复用这些文档吗?可以——它们采用 CC-By 3.0 许可证,README 里明确说明该许可证鼓励分享。
文档里的 CL 和 LGTM 是什么意思?CL 指的是 changelist(改动列表):一次提交到版本控制或正在走代码审查流程的、自成一体的改动——其他组织称之为 change、patch 或 pull request。LGTM 意思是 Looks Good to Me(我看没问题),是审查者批准一个 CL 时说的话。
审查者指南和作者指南是两份不同的文档吗?是的——代码审查指南实际上是两套独立的文档:《代码审查者指南》(The Code Reviewer's Guide)和《改动作者指南》(The Change Author's Guide),这样审查流程中的每一方都有自己对应的指南。
Creator
google
Size
0.1 MB
Stars
23.3K
Updated
CommitSep 19
Age
7y
Commits · 90 Days