loading...
Cover image for How to become a better Code Reviewer - Part 3 : How to write code review comments?

How to become a better Code Reviewer - Part 3 : How to write code review comments?

divakarkumar profile image Divakar Kumar ・1 min read

When it comes to writing code review comments do make sure that you are polite ,kind and encourage developers .


  • Respect:

1) Be kind and helpful to the developer whose code you are reviewing.
2) Make sure that you always comment about the code and not about the developer.


  • Explanation:

1) Always make sure to explain why you are making the comment
2) Try to give a "good/valid" example so that it would help developer to understand. It is always necessary to provide examples.


  • Guidance:

1) Don't provide the solution or write code for developer rather provide useful information so that it is developer's responsibility to fix a change list.
2) Maintain a balance between pointing out the problems and providing a guidance.


Thanks:

Thanks all for reading through this series . Hope you will be trying to implement this in real time practices and become a better code reviewer. If you like my post please do give feedback below , i will try to change if there are any mistakes in my future posts.

Banner Image Courtesy : Business vector created by freepik - www.freepik.com

Discussion

pic
Editor guide