How Do You Do a Code Review?

Question
How do you do a code review?

Answer
Look for consistency in style (adherence to a style guide), functionality, and ensure unit tests and end-to-end tests were performed. Keep an eye out for security issues or maintainability issues. Deploying the code should be straightforward or well documented.

Page 307 of Terraform: Up & Running, 2nd Edition by Yevgeniy Brikman (O'Reilly), Copyright 2019, 978-1-492-04690-5 says code reviews should have 1) written documentation (on how to use the code and why it was written that way) 2) example code 3) code documentation.

Be respectful to the coder when requesting changes.

To learn more, see these postings:

https://google.github.io/eng-practices/review/reviewer/
https://medium.com/palantir/code-review-best-practices-19e02780015f
https://stackoverflow.blog/2019/09/30/how-to-make-good-code-reviews-better/
https://www.perforce.com/blog/qac/9-best-practices-for-code-review
https://www.infoq.com/articles/practices-better-code-reviews/

Leave a comment

Your email address will not be published. Required fields are marked *