SwitchDin Engineering Practices Documentation

SwitchDin is developing engineering practices that cover the languages used. These documents represent our collective experience of various best practices that we have learned over time.

These documents were forked from Google’s Engineering Practices Documentation.

Currently this contains the following documents:

• SwitchDin’s Code Review Guidelines, which are actually two separate sets of documents:
  • The Code Reviewer’s Guide
  • The Change Author’s Guide

Terminology

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

• PR: Stands for “pull request”, which means one self-contained change that has been submitted to version control or which is undergoing code review.

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.