Process
Code Quality Review
Last updated:
October 14, 2021

Code Quality Reviews are aimed at assessing the overall code quality of a codebase and identifying problem areas. Low code quality may make it harder to read and review existing code and could correlate with the presence of issues.

Review overall architecture

Use a Visual Inspection Tool to generate an inheritance diagram and ensure that:

  • There are no unused interfaces or contracts
  • Inheritance hierarchies are clear & consistent

Ensure internal requirements are observed

Minimally, code should consistently follow whatever style standards are used by the team:

  • Formal coverage requirements for tests
  • Use of a linter
  • A company style guide
  • Consistency of code style throughout the repository

Ensure community standards are observed

Use your judgment to review other aspects

There are aspects of code quality that have to be assessed in context. Other questions to check include:

  • What is the overall quality of the documentation?
  • Is the code easy to maintain?
  • Is the code easy to reuse/evolve in the future?
  • Is the code modular?
  • Does the code have manageable complexity (nesting, number of arguments for functions, etc.)?

See Also: