Code Review Checklist

Code Review Checklist

Before asking for code to be reviewed, the following steps should be completed. This will ensure a smooth review process and help code to get checked in more quickly.

  • Javadocs created/updated
  • Method and class level comments added
  • Back office documentation updated (including screenshots)
  • For Touchscreen changes, test changes on Firefox version 3.5.4, and ensure all function calls and syntax are compatible with ES5 (https://caniuse.com/ is a great resource for this)
  • Unit tests have been created
  • Code coverage has been run against updated code
  • Functional testing completed
    • Ensure the overall solution works as well as addressing the specifics of the task.
  • Format code
  • Run through builds with all unit tests
  • Review classes/methods added for references
  • Check imports in classes
  • Ensure branch is up to date with trunk
  • SQL scripts have been added. Ensure applicable constraints, indexes, and foreign keys are included.

 


    • Related Articles

    • Code Review Policy

      Code Review Policy Objective: The primary goal of our code review process is to ensure high-quality, maintainable, and efficient code that aligns with the team's standards and best practices. Code reviews serve as a collaborative effort to enhance ...

    • Check Code Into Subversion

      Instructions Once you have run your project and you are satisfied with your test results, you will want to check in code to our repository. All of our code is stored in a central repository hosted in our data center. The subversion tool, Tortoise ...

    • Guidelines for Committing Code

      Atomic Commits: Keep each commit focused on a single logical change. Avoid mixing unrelated changes in the same commit. Descriptive Messages: Write clear and descriptive commit messages summarizing the changes introduced. Start with a short, ...

    • Development Best Practices

      Development Best Practices Code Review Checklist Code Review Checklist Subversion Best Practices Branches Always put in comments when checking into subversion Create one branch per task Name branch with Redmine task number and short description (Ex. ...

    • Developer Guide

      Installations An installation guide can be found in the Setup a New Developer Machine guide. Version Control Guide We use both Subversion and Git for version control. A crashcourse of our Subversion versioning processes can be found in the Subversion ...