Code Review Small Tips

As we know code reviewing is important approach for the most development department. It helps to enhance the code quality, let you to see how the others write code and how they think…etc.

I share my experience over the past two years that noticed when I and my colleagues review each other’s code.

In-Review

• Code Level

1. Start by taking an overview of the code, read the commit description if it exists. It sometime called “Skimming and Scanning” which is techniques for quickly reading text (in our case reading code 😄).
2. After you have understood the business behind the product, try to run and execute the code if it possible. This will provide to you a deep scenario look.
3. Collect your notes, write your comments about the business logic and ask the developer if you have a misunderstanding about the logic.
4. Now, write your comments about the programming style (sometime you will need a checklist to follow the guidelines). Did you find something new on the code? GOOGLE IT! It’s time to learn something new for you…Deep dive to the code!

• Feelings Feelings!

1. It may comments affected negatively to the developer whose code you are reviewing. Therefore, you need to be kind and courteous when you write the comments. Try to sure that you are writing comments about the code not about the developer.
2. Explain your comments; why you are writing your comments?

Post-Review

• Open to Discuss

1. In case you wrote a comment, it may be wrong or right! Be sure to listen to developer. So she/he can give her/his ideas, opinions, etc. about the code.

• Scanning!

1. This is the final look on the code, make sure your comments are reflected to the code and everything is OK.

That’s it!

Share with me your way of reviewing the code 😄

Bye.