Skip to content

How to do Code Reviews

Dusan Orlovic edited this page Aug 23, 2023 · 6 revisions

Things you should verify as you code review a PR:

  • Make sure the defined dev process is being followed
  • Make sure the PR is great and that all commits in the PR are great
  • Make sure I18n best practices are followed
  • Make sure the build for the PR is green
  • Make sure the changes are tested at appropriate level (see rspec tips and karma tips for help)
  • Make sure tech best practices are being followed
  • Focus on the implications, design, readability and complexity of the change rather than only its syntax. The latter is what machines are meant to do and that's why we use Rubocop.
  • Make sure code conventions are followed (things Rubocop doesn't check)
  • Make sure the boy scout rule is applied: when changing code, it's important to respect the existing structure, but it's even better when we refactor on the way and improve the code we are changing.
Clone this wiki locally