Code Review Checklist - Jomsaruj/DEK-COM GitHub Wiki

The following attributes should be verified during a code review:

Repository

Branch management

  • Anything in the master branch is deployable.
  • The latest version of application always merge into develop branch before master branch.
  • Always delete unnecessary merged branch.
  • Avoid unnecessary pull requests.

Project structure

File location management

  • All image files located in media directory.
  • All HTML files located in templates directory.
  • All CSS files located in static directory.

Clarity and Maintainability

Coding style

  • Code is clear and easy to understand with no complex coding style.
  • Docstring always contain information about method description, parameter(s) and return value.
  • Well commented and documented so other programmers able to maintain the code.
  • Write communicate code by introduce explanatory variable.
  • Always run Flake 8 and modify the code.
  • Refactor the code to make the code clearer.

Modularity

Directory management

  • Separate each part of test.py into individual test file.
  • Separate each part of models.py into individual models file.

Reliability and Robustness

Unit testing requirement

  • Unit test is readable.
  • Always test edge case and extreme value.
  • Implement Continuous Integration.