@_vmlops - Google Publishes Internal Code

Open original

@_vmlops on X Google has put its internal code review guidelines on GitHub, covering separate guides for reviewers and authors. The post also explains internal shorthand like "LGTM" and "CL" that most outside developers won't recognize.

  • Google's eng-practices repo on GitHub contains two guides, one for code reviewers and one for code authors.
  • The guides define internal terms such as "LGTM" (looks good to me) and "CL" (changelist).
  • The post frames reviewing code as a separate skill that most developers never learn to do well.

Google has published its internal code review guidelines on GitHub at github.com/google/eng-practices. The repo contains two guides, one aimed at reviewers and one aimed at authors, and together they describe how engineers at Google are expected to submit and evaluate code changes. The post's main point is that writing code is a skill most developers pick up, but reviewing code well is rarer, and Google has documented its approach in public. The post also gives a small glossary, which is useful if you have ever been confused by Google-internal jargon. "CL" stands for changelist, Google's term for a single proposed change to the codebase, roughly what other companies call a pull request. "LGTM" means "looks good to me," the approval a reviewer gives. The author is pointing out that these terms show up constantly in Google-related writing and talks, and that the guides define them in plain terms rather than leaving readers to guess. The post is short and mostly a pointer. It doesn't summarize the guides' contents, so if you want the substance you'll need to read the repo itself, which is worth doing for anyone who runs a team or does a lot of code review. The tweet is a link to the source rather than an analysis, so treat it as a bookmark to the GitHub repo, not a substitute for it.

Ask about this article