What is this?
Google's Engineering Practices documentation — a public collection of guides distilling the engineering practices Google applies across all languages and projects, currently focused on its Code Review Guidelines.
Google's Engineering Practices documentation — a public collection of guides distilling the engineering practices Google applies across all languages and projects, currently focused on its Code Review Guidelines.Is this a tool I can run, or just documents to read?Just documents, no code to run. The repo holds Google's Code Review Guidelines, written as two separate guides: one for code reviewers and one for change authors.
Just documents, no code to run. The repo holds Google's Code Review Guidelines, written as two separate guides: one for code reviewers and one for change authors.How do I read it — is there anything to install?Nothing to install. The guides are plain markdown in the repo and also published as a static site on GitHub Pages, so you just open them in a browser.
Nothing to install. The guides are plain markdown in the repo and also published as a static site on GitHub Pages, so you just open them in a browser.Is this still actively maintained?No. The repository is archived and read-only — the guidelines stay available, but they are no longer updated here.
No. The repository is archived and read-only — the guidelines stay available, but they are no longer updated here.Who are these guidelines written for?Google engineers first of all — some documents use Google-internal terms like CL, which the README clarifies for external readers — but they were published so open source projects and other organizations can benefit too.
Google engineers first of all — some documents use Google-internal terms like CL, which the README clarifies for external readers — but they were published so open source projects and other organizations can benefit too.Can I share or reuse these documents?Yes — they are licensed under CC-By 3.0, a license the README explicitly says encourages sharing.
Yes — they are licensed under CC-By 3.0, a license the README explicitly says encourages sharing.What do CL and LGTM mean in these docs?CL means changelist: one self-contained change submitted to version control or going through code review — other organizations call it a change, patch, or pull request. LGTM means Looks Good to Me, what a reviewer says when approving a CL.
CL means changelist: one self-contained change submitted to version control or going through code review — other organizations call it a change, patch, or pull request. LGTM means Looks Good to Me, what a reviewer says when approving a CL.Are the reviewer and author guides different documents?Yes — the Code Review Guidelines are actually two separate sets of documents: The Code Reviewer's Guide and The Change Author's Guide, so each side of a review gets its own guide.
Yes — the Code Review Guidelines are actually two separate sets of documents: The Code Reviewer's Guide and The Change Author's Guide, so each side of a review gets its own guide.What are similar projects?architecture-decision-record, project-guidelines, awesome-guidelines, unmaintainable-code, community, guide, HowToBeAProgrammer, How-To-Ask-Questions-The-Smart-Way
architecture-decision-record, project-guidelines, awesome-guidelines, unmaintainable-code, community, guide, HowToBeAProgrammer, How-To-Ask-Questions-The-Smart-WayWhich topics is it in?guides, guidelines, engineering, software-engineering, code-quality, code-review, collaboration, google, best-practices, reference, guide, learning-resources
guides, guidelines, engineering, software-engineering, code-quality, code-review, collaboration, google, best-practices, reference, guide, learning-resources