Skip to content
Lab651 Process

Code Reviews

Code Reviews

Section titled “Code Reviews”

All code submitted to the repository needs to go through a code review before it can be merged.  Execute the code review through the SCC that is being used.  If the Jira board has a Code Review column, put the ticket there and assign it to the engineer performing the code review.

Code Review Focus

Section titled “Code Review Focus”

The process of the code review is to ensure that the code is well formed and works properly.  If any of the following appear in the code Look for the following.

  • Logic errors - Verify that the code flows well and does not have obvious flaws
  • Best practices - Verify that the code is using the best practices in terms of architecture, style, variable/method naming, etc…
  • Style guidelines - Verify that the code uses the agreed-upon style.   All code should be consistent in the project.  When code styles differ, it can be very difficult to read across files or even within a single method.
  • Requirements fulfillment - Verify that the code fulfills the original requirements of the ticket.
  • Unit Test coverage - Verify that Unit Tests cover the implemented code completely and accurately.  Changes in code may require changes in Unit Tests.

Benefits

Section titled “Benefits”

There are many benefits to code reviews

  • Exposure of new/fixed code to other team members
  • Peer pressure to write good code that has good unit test
  • Training for new engineers in the way the code works
  • Training for junior engineers (add them as non-blocking on the Pull Request)
Section titled “Related”