Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Improve the efficiency of code review process within Escalation Team. This document will provide a set of guidelines which can be followed according to the scenario which can help efficient feedback from the reviewers. 

Problem statement

  • Escalation covers multiple teams (TNL, PLAT, ECOM) and sometimes it's unclear whom to ask for a code review within the team. 

Guidelines

  • Well Groomed JIRA Tickets:
    • Code review process can be faster if a ticket is properly groomed. Very rarely someone will start a discussion on the PR' which could delay the code review.
    • To avoid re-do, discuss major refactoring solution within the team or anyone on board before implementing it.
  • Need of I.F.R. within team:
    • The Initial Fast Review (I.F.R.) is critical within the team.
    • If you really need to tag someone in Cambridge, make sure your PR has an I.F.R.
      • Why? It's a 12hr turnaround, between Cambridge and Lahore, and you would be ready to merge as soon as you get the 2nd review.
  • Taking and Sharing the Responsibility:
    • Code review is as important as fixing issues. 
    • Its reviewers' responsibility to ask if he is unclear about anything in the PR.
    • If a reviewer is busy and can't find time for a review, Share the responsibility by referring someone else to the team for the review.
  • Idea of M.I.C:
    • The idea of Making It Count (M.I.C.) means the fix should go out. This will help us get improved velocity in Review Meeting. The number of merged issues will definitely improve the velocity of the team.
  • The Sandbox Logic:
    • A sandbox is a must for every TNL issue and wherever it is applicable. It helps reviewer to observe where the problem was, and if it actually fixed the issue.
      • Sandbox Vs Stage theory: It can help quickly understand a fix. Stage would be experiencing the problem but not the Sandbox (as Sandbox would be pointing your branch).
  • Use of Sustaining Pull Request Template:
    • The Pull Request Template covers all the major areas that a reviewer can think of. Using the template would ease a review cycle.
  • Communication:
    • Start the communication if do not know where to start. Following ways can help you.
      • HipChat: Use `@team` in Escalation Group to ask for a review.
      • Skype: Send personal message a reviewer.
      • In-person: You can always jump to the person after asking his availability. 
  • No labels