Code Review best practices

Everyone has there own set of best practices. Here are the few points which I would like to share with you regarding the code review.

The aim of the code review is to build the team spirit, improve the code quality and collaborative learn the best practices.

One feature at a time

Make sure your CRR or commits are based on single feature or story or bug fix. Keeping multiple feature or bug fixes in a single code review request will create more confusion. So keep it simple.

Add members to review

Add everyone from team into in your code review request. At least 2 reviewers should review your code before it has been merged to the remote repository.

Information about what has been changed

Add information about what has been changed in the CRR. Add the related tickets/story/bug link in the CRR (in most of the cases). This will help the peer reviewers to get an insight or information about the task.

Notify the team

Send an Instant message to your team when the CRR request is sent or when the individual completes reviewing a particular request.

If you have any automated system like web hook or slack notification, thats fine. Otherwise, it’s OK to maintain a seperate channel or group to discuss about CRR.

Write it simple and clean

Keep the commit message concise & clear (if it is a bug fix mention it clearly).

When you are reviewing, look into the code and make sure you understand what code does actually; if there is any doubts/clarification needed highlight the code and add comments for clarification.

The aim is to have a readable code, so that remaining team members can also understand.

Be a advisor

If you find the code is difficult to understand or it could be even simpler feel free to suggest the better way to do that.

It’s a good habit to suggest something good instead of just mentioning that particular piece of code can be improved.

Maintain patience

Don’t urge to get your code get reviewed; Give some time to the reviewer and add a gentle reminder if it takes too long.

Be gentle

Stay humble, all these processes are to improve ourselves in a better way.

Code review process is to improve the code quality and build the team spirit in a better way. Collaboratively we can learn more from Code Reviews.

Happy Coding!

Advertisements

Top 5 books every Web Developer should read

So many books, so little time.

One of my mentors said to me, to read a complete book every month. He suggested me to read at least 2 books each month.

  • One book for technical stuff
  • One book for non technical stuff

Thanks Uday. It’s a good guidance at the right time in the start of my career.

I took that guidance seriously and started to read books.

I used to track the books I read in good reads website. You can find the list of books in my goodreads profile.

Coming back to the theme of this post.

Here is the list of my favorite books related to web development as well as General professional development.

The Clean Coder: A Code of Conduct for Professional Programmers

Image result for The Clean Coder: A Code of Conduct for Professional Programmers

Author: Robert C. Martin

The Art of Readable Code

Image result for The Art of Readable Code

Author: Dustin BoswellTrevor Foucher

Don’t Make Me Think, Revisited: A Common Sense Approach to Web Usability

Image result for Don't Make Me Think, Revisited: A Common Sense Approach to Web Usability

Author: Steve Krug 

JavaScript: The Good Parts

Image result for JavaScript: The Good Parts

Douglas Crockford

Even Faster Web Sites

Image result for even faster web sites

Author: Steve Souders

Disclaimer: The ordering doesn’t related to quality of book. Its purely sorted based my personal favorite.

You can start with any of the book. Comment your favorite book in the comment section below.

To get latest updates you can follow or subscribe! #peace