Philosophy

Our approach to code reviews centres around a few key principles:

Accountability: We perform code reviews to hold each other accountable for the quality of our work. It ensures that mistakes are caught early and learning opportunities are shared among the team.

Learning: Code reviews are a great way to learn from each other and to continuously improve our coding skills. It allows us to see different approaches to solving problems and learn new techniques.

Maintainability: Code reviews help ensure that our codebase remains maintainable, readable, and coherent. It’s a way to enforce coding standards and keep the style and structure of our code consistent.

Collaboration: Code reviews encourage better collaboration among our team. It's a cooperative process where developers can give and receive feedback, leading to better and more efficient code.

Read more Engineering Guidelines

Preparing Code for Review

Commit Messages

We use conventional commits.

Conventional commits are an effective method for maintaining clean and readable commits. While it may take a moment to get used to, it quickly becomes second nature after a few commits.

Example

feat: allow provided config object to extend other configs

Github PR Descriptions

Your PR descriptions should be an extension of your commit messages. Write about both what the commit changes, and how you implemented the change.