Coding Standards and Guidelines

Purpose

The purpose of this repository and documents are to establish a baseline set of standards and practices that the team will follow. Most of these standards and practices are guidelines, and none of them are set in stone. If you ever have questions, concerns, or recommended changes, then please communicate them via comments within this repo itself or directly to the Engineering Leadership team.

Table of Contents

• General Guidelines
• Definition of Done
• Code Review
• Project Organization
• Git Guidelines
• Release Process
• References

History

This set of coding guidelines was originally created by John Grogg while at FreshRealm with significant contributions from Sakwa Alvitre and Ondrej Nebesky. It was later generalized to be more broadly useful. Feel free to fork and use as desired.