Skip to content
This repository has been archived by the owner on Nov 8, 2018. It is now read-only.

PR Reviewing Best Practices (for Mentors)

Jump to bottom
Dinu Kumarasiri edited this page Nov 21, 2016 · 2 revisions
  1. Make sure the PR has a description of what is done in the PR with a meaningful title. If the PR solves an issue in the issue list, make sure the title has the issue number.
  2. If the PR is changing the user interface, check whether the PR has the screen shots of the change.
  3. Review the code. If you are not sure about your review and found no mistake, put a +1 in the comments. If you are sure about the review merge it.
  4. When merging, if the PR is for a small change and it contains unnecessary number of commits squash it before you merge it by giving a meaningful commit message.
  5. If the number of commits are justifiable and with good commit messages, merge it normally.
  6. If the PR resolves an issue, close the issue from the issue list adding the comment "fixed via #PR".
  7. Last but most important, verify that the PR is sent to the develop branch, not to the master branch.
Clone this wiki locally