Goals


Code reviews are not for


Workflow - Asking for a Review

  1. Work on an issue/story, committing early and often to the shared code-base
  2. Create a review that is focused and concise, asking for a particular piece to be reviewed and why.  e.g. a new public class you intend others to use, a change to a method someone else last worked on.  See Creating a Review and the Code Review Checklist
  3. Add a reviewer to your review.  Choose someone who's more experienced or whom has worked on a tricky area before.  If you're unsure who to add or who's available, your Team Lead can help.
  4. Expect your review to be completed within 1-2 business days.  Set a due date if you need a reminder.  If the review isn't complete in that time, re-assign the review to someone else, asking your Team Lead to help.  It is your responsibility to ensure your code review isn't dropped and your Team Lead to help find the right people review the code on time.
  5. If your review has feedback or issues to address, ensure you respond to the feedback promptly and add any new code from that discussion to the review.  Re-open the review to your reviewer. Do not click the 'Resolve' button on comments you resolved - this meant for the reviewer to keep track of the review.
  6. When your reviewer has completed, all feedback addressed and any new review items properly reviewed, please close the review.


Workflow - Reviewing Code

  1. You've received a request for a review, open the review - participating in code reviews helps us all improve
  2. If you're unable to complete this review before the due date has passed, please inform the review author so they may re-assign it.  If you feel strongly that someone else would be a better fit, suggest that to the author.  Try not to leave a review half-way through, commit to it till it's closed.
  3. Review the change, following the Code Review Checklist
  4. Provide constructive feedback if warranted or simply acknowledge that the code looks OK.  If you have concerns, be specific and reference the components in the review checklist, mark the concern as a defect. You can use the "Needs Resolution" feature to mark comments as requiring to be resolved.
  5. Make sure that whenever already existing logic is modified a new test is added that checks the specific change that has been implemented (along with updates to already existing tests, if they were needed).
  6. Complete the review. If you left feedback, be ready for review author's response to them.
  7. Participate in the review until all problems are resolved (bear in mind to complete review every time you finish providing feedback). If you marked issues as needing resolution and they were resolved, then mark them as so.
  8. To inform review author that it may be closed, acknowledge that the code looks OK and complete the review.


Team Leads


Creating a Review