The Shpock backend team 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:

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

There is some Shpock-internal terminology used in some of these documents:

• PR: Stands for "pull request", which means one self-contained change that has been submitted to version control or which is undergoing code review. Other organizations often call this a "change", "patch", or "changelist".
• LGTM: Means "Looks Good to Me". It is what a code reviewer says when approving a PR.

The documents in this project are based on the Google Engineering Practices documentation. They 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.