Skip to content
Marc Lavergne edited this page Sep 10, 2023 · 1 revision

Code review components

  1. Does the code contain any logical errors? (ie. Is anything broken?)
  2. Is the code formatted in consistent manner? (ie. Is the format standard?)
  3. Does the code have sufficient quality documentation? (ie. Is there documentation and comments?)
  4. Does the code satisfy relevant specifications? (ie. Are the results according to spec?)

Code review pros

  1. Improve code quality
  2. Stop flaws before they reach mainline
  3. Improve documentation
  4. Promote knowledge transfer

Code review cons

  1. Slows code delivery
  2. Consumes limited resources
  3. Effectiveness depends on reviewer's experience level
  4. Inherently opinionated process

Code review recommendations

  • Leverage automated code quality tools as much as possible
  • Establish guidelines for code reviews
  • Any change request or lack of an approval must be accompanied by a standardized reason for not approving.

Clone this wiki locally