Skip to content

Code Review Checklist

jamesfernando94 edited this page Nov 29, 2018 · 6 revisions

All Code

  • Looked over code for errors
  • The code 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
  • There are no intellij/eclipse errors
  • Can any code be replaced with a library or build in function

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
  • All the unit tests pass

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

Clone this wiki locally