Code Review Script - Jomsaruj/DEK-COM GitHub Wiki

Purpose: procedure for in-person and online code reviews to find as much as possible defects, which lead to better code. Summary: In code reviews meeting, team will reviewing a work product and fixing any defects that are found.

Entry Criteria

  • Team member require to review code individually before the meeting.
  • Code review checklist must be created.
  • Code review script must be created.
  • Assign a unique version number to the work product for example, release-v2.0.

Basic Course of Events

code review procedure

  • The moderator post Code review checklist then each inspector reads the work product and identifies any defects.
  • The moderator make sure that inspector well prepared.
  • Each inspector review code line by line only 20-30 minute then take a break.
  • Open an issue for each defect founded.

NOTE: Do not repair defect while you are reviewing the code, left it as an open issue and fix it later.

follow up

  • Team repair defect and close the issue.
  • Team verify that defect were repaired.
  • Approves the work product.

Exit Criteria

  • All defect is fixed.
  • Files and directories are well organized.
  • Code is readable and easy to understand.
  • Unit test is reliable.