Skip to content

Code Review Checklist

jamesfernando94 edited this page Nov 30, 2018 · 6 revisions

All Code

  • Looked over the code for errors
  • The code is written using coding standards/guidelines
  • There is no repeated code
  • No functions are too big which can't be split up/made smaller
  • No classes are too big which can't be abstracted/generalised
  • Proper naming conventions have been used throughout the code i.e. camelCase
  • No lines are too long to fit on the screen i.e. longer than 80 character widths
  • There is no commented out code
  • All the files are in the correct folder
  • There are no unused files
  • There are no typos/spelling mistakes
  • Can any code be replaced with a library or built-in function
  • There aren't any magic strings which can be removed/substituted
  • Exceptions are only used for exceptional cases i.e. during the normal course of operation exceptions are not used
  • There are no ide files included

Java/Springboot

  • Are all complex public functions Javadoc commented
  • Are all Controller methods properly documented using @Api tags and javadoc comments
  • The project builds successfully
  • The project starts correctly
  • All the unit tests pass
  • There aren't any unused imports
  • There are no intellij/eclipse errors

Swagger

  • The swagger UI displays properly
  • The swagger UI works properly
  • The static swagger HTML page is generated correctly
  • The static swagger pdf document is generated correctly

React Native

  • Each UI element is their own component
  • There isn't too much logic in the render method
  • React components can't be easily split up
  • Don't edit props within a component
  • All components have a display name
  • There aren't any ide errors

Clone this wiki locally