Engineering Processes¶

Introduction¶

This document describes the engineering processes that we follow at Car & Classic. These processes are designed to ship quality code in a reasonable time frame.

Shipping Code¶

Branching Strategy¶

We use a master branch as the main branch for our codebase. All feature branches are branched off master and merged back into master via pull requests.

Pull Requests¶

All code changes must be submitted via a pull request. Pull requests should be reviewed by at least one other engineer before being merged.

Continuous Integration¶

We use continuous integration to run tests and checks on every pull request. Pull requests cannot be merged until all checks pass.

Reviews¶

All code changes must be reviewed by at least one other engineer before being merged. Code reviews are an important part of our process and help to ensure that we are shipping quality code.

Deployment¶

We deploy code to production multiple times a day.

Code Review¶

Why do we do code reviews?¶

Code reviews are an incredibly important part of our development process. They help us to:

expose bugs before they reach production;
ensure consistent code quality;
create an environment for sharing knowledge and developing skills;
cross-pollinate debugging skills when problems arise;
cultivate the ability to critique one’s code more strongly;
encourage open communication between the entire team.

Our goal is to review code, not the coder. We are all here to learn and improve.