Skip to content

Code review process

Steven Than edited this page Jan 29, 2019 · 2 revisions

For reviewee

  1. [Reminder] Run npm run test before creating pull request, Travis CI will also run tests for you, but it's much slower than your local environment
  2. Create pull requests
  3. [Optional] Tag the person who you would like to be your reviewer
  4. A notification will be sent to visual-team slack channel, if nobody is tagged as reviewer, anyone can review the pull request
  5. If there are comments, read them and make sure they are resolved
  6. If there's a need for changes, you can keep the pushing commits onto the same branch, notify your reviewer when new codes are added for further review
  7. [MOST IMPORTANTLY] DO NOT TAKE PR COMMENTS PERSONAL, IT'S ABOUT YOUR CODE, NOT ABOUT YOU

For reviewer

  1. Keep tab on slack channel for new pull request (Ideally a pr should be reviewed within the day to keep the development process going)
  2. Go through every file in the Files changed tab (even package.json) and give your comments, be considerate and thorough with your comments
  3. Clone and run the pull request locally to make sure everything looks good, and nothing is breaking (this step won't be necessary anymore once we are able to spin up an AWS for each pull request)
  4. Give your approval and merge the pull request

Clone this wiki locally