eng-practices
Google's Engineering Practices documentation
Google's publicly shared engineering guidelines covering how to run code reviews effectively, written for both reviewers and change authors based on practices used across all of Google's engineering teams.
This repository contains Google's Engineering Practices documentation, which covers generalized engineering practices developed across all languages and projects at Google. The documentation is published publicly so that open source projects and other organizations can benefit from Google's accumulated experience. Currently it contains Google's Code Review Guidelines, which consists of two separate guides: the Code Reviewer's Guide and the Change Author's Guide. The documents use some Google-internal terminology, including CL (changelist, equivalent to a change, patch, or pull request) and LGTM (Looks Good to Me, used when a reviewer approves a CL). The documents are licensed under CC-By 3.0.
Where it fits
- Adopt Google's code review process as the standard for your team's pull request workflow.
- Use the Change Author's Guide to write better pull request descriptions and smaller easier-to-review changes.
- Share the Code Reviewer's Guide with new team members to set consistent expectations for review quality.
- Reference Google's criteria for what makes a change ready to merge when resolving review disagreements.