Skip to main content

Posts

Showing posts from 2020

Code Review - Best Practices

Code review is a great learning and knowledge sharing tool not only for the new members of the team but for the long time company veterans as well. Having a code review process in place dramatically improves the code quality and helps detect bugs in an early stage. Much of what I wanted to write here has already been captured in this great post form smartbear. However, here are the important bits:   Author: Size matters. Keep it under 400 lines. For bigger change, break down the review in meaningful chunks. Provide a detailed context of the change. I prefer commit message and will recommend to follow similar format from Linux project [ link ] Provide details of tests performed to verify the change. Review your code before publishing and add annotation to help guide the reviewer. Reviewer: Take it slow but not longer than 60 minutes. Use checklist of what to look for in code review. Example checklist [ link ] Read the story and understand t