Created
October 12, 2015 03:07
-
-
Save anotheredward/099b598b9d775d953326 to your computer and use it in GitHub Desktop.
Starting point for a Code Review checklist
This file contains hidden or 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
<h2>Code Review Checklist</h2> | |
<input type="checkbox"> Read Ticket <br> | |
<input type="checkbox"> Works from clean install <br> | |
<input type="checkbox"> Test Functionality: Does it solve the problem/satisfy the AC? <br> | |
<input type="checkbox"> Green path <br> | |
<input type="checkbox"> Red path <br> | |
<hr> | |
<p>Look for</p> | |
<input type="checkbox"> Errors in inspector <br> | |
<input type="checkbox"> Usability errors <br> | |
<input type="checkbox"> Quick review for naming/Style/linter errors <br> | |
<hr> | |
<input type="checkbox"> Understand domain <br> | |
<hr> | |
<input type="checkbox"> looking for things that will confuse people later in the future <br> | |
<input type="checkbox"> remove comments <br> | |
<input type="checkbox"> remove dead code <br> | |
<input type="checkbox"> consistency checks <br> | |
<input type="checkbox"> readability <br> | |
<input type="checkbox"> JSDOC for any libraries/external funcs <br> | |
<hr> | |
<input type="checkbox"> Correct use of <br> | |
<input type="checkbox"> JS: Specifically ES6 <br> | |
<input type="checkbox"> Libraries: Date, Regex, Array, String, etc. <br> | |
<input type="checkbox"> Moment <br> | |
<input type="checkbox"> Ramda <br> | |
<input type="checkbox"> Reduce to simplest, most common functional expressions <br> | |
<input type="checkbox"> Split in to sensible named pieces, not just having infinite chains <br> | |
<hr> | |
<input type="checkbox"> Correct use of Framework (Ember/Loopback) <br> | |
<input type="checkbox"> Structure/Architecture? <br> | |
<input type="checkbox"> Error Handling <br> | |
<input type="checkbox"> Logging <br> | |
<input type="checkbox"> Are things split up in a good fashion? <br> | |
<input type="checkbox"> Are they in the right place? <br> | |
<hr> | |
<input type="checkbox"> Potential for error <br> | |
<input type="checkbox"> Potential for security flaws <br> | |
<input type="checkbox"> Only client-side validation <br> | |
<input type="checkbox"> Performance concerns? <br> | |
<h2> Questions </h2> | |
<li> Is it worth reviewing individual commits or just the end result? | |
<li> How much do I need to understand the domain before reviewing? | |
<li> How many passes are required? Passes aren't good | |
<li> Is it useful to split them up? No | |
<li> Compose vs Pipe? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment