Engineering Playbook
Code Reviews
Code reviews are a basic part of ensuring what we deliver functions well and adheres to our own style guides and quality control criteria.
Each pull request has to be reviewed and signed-off with a team member.
While reviewing a pull request please ensure you follow these guidelines:
- Take time: Never review in a rush. It is a recipe for failure.
- Test: Pull the branch locally and test the feature. If you find the feature in action you’ll be able to review it better.
- Read the description: Make sure the pull request has a brief description of this feature or improvement. It is extremely important to find context from the writer’s perspective.
- Be optimistic: We are all on the same team. Any sort of slander or provocation isn’t okay.
- Ask questions: When something is not making sense seek an answer from the author.
- Legibility: Legible code is much more reusable and future-proof. The author will always feel as it is readable but also you as the reviewer are the actual judge of this. Everything in terms of variable names, function names, class names, and modules should be understandable.
Code Reviews
Code reviews are a basic part of ensuring what we deliver functions well and adheres to our own style guides and quality control criteria.
Each pull request has to be reviewed and signed-off with a team member.
While reviewing a pull request please ensure you follow these guidelines:
- Take time: Never review in a rush. It is a recipe for failure.
- Test: Pull the branch locally and test the feature. If you find the feature in action you’ll be able to review it better.
- Read the description: Make sure the pull request has a brief description of this feature or improvement. It is extremely important to find context from the writer’s perspective.
- Be optimistic: We are all on the same team. Any sort of slander or provocation isn’t okay.
- Ask questions: When something is not making sense seek an answer from the author.
- Legibility: Legible code is much more reusable and future-proof. The author will always feel as it is readable but also you as the reviewer are the actual judge of this. Everything in terms of variable names, function names, class names, and modules should be understandable.
