Skip to main content

Guidelines for code reviews

Here are some useful checks while doing code reviews:

  1. Is the code readable?
  2. Can we dry it up?
  3. Is it an experiment
    1. new- Is the code written such that clean up will be easy?
    2. removing old - Are all part of the experiment removed?
  4. Is the code written in a way that may cause unexpected behavior => eg: using a class which has a .click handler in some other file which is not obvious.
  5. Is new css added?
    1. Is it really needed?
    2. Is it using existing variables - app/assets/stylesheets/themes/_powr.css.scss
    3. if touching z-index - any side effects - has Kelsey seen it?
  6. If db reads- are we accidentally doing n+1 query?
  7. If db inserts/updates - are we checking if the user has permission to do those?
  8. skip screenshot : true for large app migrations.
  9. migrations: https://www.getoutline.com/doc/migration-checklist-3QjXxFgOUX