Skip to content

Code Review Checklist

CJ R edited this page Mar 3, 2019 · 1 revision

General

  • Linter Passes
    • Consistent Indentation and Code Style
    • Ignored linting rules are justified
  • Good variable names
    • No 2-3 letter abbreviations
    • Not overly descriptive
  • Ambiguous or Confusing code is commented
  • Comments are updated if needed for changed code
  • Functions are appropriately broken down into smaller functions
  • Is the code duplicated more than twice?
  • Is security taken into account?

Testing

  • Does the work complete all acceptance criteria?
  • Is the code written in an easily testable way?
  • Does the test suite pass?
  • Is any new functionality appropriately covered by tests?
    • No unnecessary or unused tests

React Specific

  • All this.state and this.props are destructured
  • Components are broken down at the appropriate level
    • Generally Highly Re-usable
  • Good prop names
  • State in component is justified

Release Specific Code Review

  • Package version is correctly incremented
  • Tag is created
Clone this wiki locally