Created
January 10, 2017 21:55
-
-
Save ebuckley/ed9321e9e1c796eae9bc6134e364b1c2 to your computer and use it in GitHub Desktop.
Code review checklist
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Code Review Checklist | |
Understand the change | |
Read Pull Request description and Ticket | |
Functional Test | |
Does it work from a clean install? | |
Does it solve the problem and satisfy the AC? | |
(Green Path) Does everything work if you go through the intended steps? | |
(Red Path) Does the application help you and make sense when things go wrong? | |
Look out for | |
Errors in inspector | |
Usability, Does it make sense to a user who has never seen it before? | |
Standard Linter errors? | |
Read the code | |
Potential learning? (Do you understand all the code?) | |
DRY? | |
Logical Errors, Edge Cases, Configuration Values, Operator Precedence | |
Names make sense | |
Check for anything that might confuse developers later | |
Remove dead comments and code | |
Small functions | |
Consistent with other code? | |
Readable? | |
JSDOC for any libraries/external funcs | |
Does it have tests? | |
Style Check | |
Does it interact with other parts of the system? | |
Correct use of | |
JS, ES6, Date, Regex, Array, String, Object | |
Moment | |
Ramda | |
Correct use of Framework (Ember/Loopback) | |
https://github.com/dockyard/styleguides/blob/master/engineering/ember.md | |
Are things in the right place? | |
Components + Data down Actions up? | |
Asynchronous calls are really really right? | |
Validation | |
Potential for error | |
Potential for security flaws | |
Performance is acceptable |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
credit to @anotheredward for holding the discussion and extracting the checklist for the team <3