Advertisement
Guest User

Untitled

a guest
Jul 28th, 2017
63
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 2.35 KB | None | 0 0
  1. Kellen's Code Review process:
  2.  
  3. 1. Open up code review link or linked commits in a browser.
  4. 2. Check out the branch on my local.
  5. 3. Go line by line through the modified code looking for:
  6.  
  7. - Functionality checks - Is the code doing what it's supposed to? This involves verifying that the developer read and correctly understood the intent of the feature and wrote code that accomplishes the desired functionality.
  8. - Code organization - Is the code organized in a way that makes sense? Example: We want page templates and template parts to be mostly markup and for logic to exist in functions/methods in separate files rather than having everything commingled together.
  9. - Functions & hooks - Are safe and correct functions & hooks being used? Example: using PHP's current() to get the value of the first element in an array behaves differently in PHP7 than it did in older versions and that can introduce bugs - it's safer to use $array[0] syntax instead.
  10. - Sanity checks - Are sanity checks in place to verify data is what we expect it to be at any given point?
  11. - Sanitization - Is data from user input or other external sources being sanitized before we work with it or store it?
  12. - Escaping - Is data being escaped using the correct functions before it's output?
  13. - Internationalization - Are all string literals in the code translatable?
  14. - Performance - Is the code written in the most optimal way so that it will load quickly? This often involves using less computationally expensive ways of accomplishing things and implementing caching.
  15. - Inline documentation - Did the dev include inline documentation to explain things that may not be immediately obvious? Self-documenting code is also acceptable, and encouraged.
  16. - DocBlocks - Are DocBlocks present and complete for all functions & methods?
  17. - Formatting and readability - Does the code meet the WDS coding standards and in general, is it formatted well and easily readable?
  18.  
  19. 4. Review the feature locally/on lab (if applicable) and verify the functionality works as intended. Try to use the feature in various ways and ensure it doesn't break, or fails gracefully.
  20. 5. Leave comments in GitHub/Beanstalk with what needs to be changed (or what was done well!) and assign back to the developer to make those changes if necessary.
  21. 6. If no changes are needed, merge the branch in. Document on the task/issue, stating that it's complete and assign to the PM.
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement