This repository is a starting point for all engineering-related practices, conventions and resources. Its main intention is to make the development process as unambigous and approachable as possible.
Most of the suggestions here are recommendations and not mandatory, but if you decide to not follow a particular recommendation please make sure you have a good reason. Consistency is key.
The primary audience for these guides is members of the Snowplow Engineering team and Software Engineering interns. The repo is also open to OSS contributors and should never include any private or confidential information.
- Style Guide - general and language-specific practices and conventions
- Branching Model - git branching model
- Release Process - software release process and checklist
This knowledge base is a subject of constant revision. In case any guides or conventions in this repository are unclear, ambigous or feel wrong, please address via PR or ticket in the repo.