-
Notifications
You must be signed in to change notification settings - Fork 4
Code Review Checklist For Data Lab (WIP)
Dylan Peinhardt edited this page Feb 1, 2018
·
1 revision
- Is the code easily understood and perform its intended function?
- Does the code conform to the agreed-upon coding conventions? (code climate?)
- Can any of the code be replaced with library functions?
- Is there any commented out code? (delete it unless necessary)
- Is there any redundant or duplicate code? (refactor it)
- Are identifiers named well? (use long, descriptive variable/function names)
- Are all the JavaScript scripts referenced necessary?
- Are all NPM packages used well-audited and from a trusted source/CDN?
- Is all user input checked and properly handled appropriately?
- Are unusual behavior/edge-cases described in the code comments?
- Are incomplete sections marked with TODO?
- Is the intent of the code described somewhere?
- Is the code testable? (written in a modular, cohesive, lowly coupled manner)
- Was the code tested to assure compliance with the acceptance criteria?
- Are individual functions robust in the face of unexpected input?
#bestteamevar