Peer review process

Document to outline the process for peer review within Team Phalanx.

The process of peer reviewing is to give a sanity check on work done by another
developer (to see that you can see their changes visually), and to do a review of the
code used and see if there are ways to improve it.

Follow the steps below when you pick up a ticket for peer review

 Assign the ticket to yourself and read the description/ comments/.

 Checkout the branch.

 Run any commands required to build/ serve the project and check for
command line errors – If there are any issues, move the ticket back to “To do”
and leave a comment including a screenshot and a comment.

 Check that you can see the result of the ticket – this will differ between tickets/
work, but you need to see some evidence that the ticket has been completed
(eg. You can see a frontend change, or you can see a change when an API is
called on Postman) – If there are any issues, move the ticket back to “To do”
and leave a comment including a screenshot and a comment.

 Check the code and see if there are any changes you think would make it less
complex/ messy - look for console.log, commented out code, unneeded
comments, if the code could be rewritten in a simpler way. – If there are any
issues, move the ticket back to “To do” and leave a comment including a
screenshot and a comment.

 If all the above has been completed successfully, leave a comment saying
that peer review has been passed in the ticket and in the Team Phalanx
channel, and move the ticket to “Ready for QA”