Skip to main content

Posts

Showing posts from May, 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. Another great blog on sa However, here are the important bits:   Author: Keep the CR small.  For bigger change, break down the review in meaningful chunks. Add TODO comments for future CR. Keep you changes under feature flag or in a separate feature branch to facilitate smaller incremental changes which are not ready to be released in production. Check this engineering blog from google on small CL . Provide a detailed context of the change. I prefer documenting context in commit message and will recommend to follow similar format from Linux project [ link ] Provide details of tests performed to verif