Tools

Code Review best practices

Pandiyan MuruganLeave a comment

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

Add some cool badges in your GitHub Repo

FeaturedLeave a comment

You might have seen this kind of badges earlier in many GitHub repositories.

Image result for shield badges github

It is cool! Most of the popular frameworks or tools using it in their GitHub repo.

Example:

Angular repository

Why Badges?

It provides a long information short!

It can hold information such as

  • version of npm used
  • status of last build
  • number of downloads happen over period of time
  • license type

How?

Now the question is how can I add it in my GitHub ReadMe file?

It pretty simple. All you have to go https://shields.io/ and create badges right away.

Basically a badge will contains small information of our repo. It can be building process status, or social media handle link.

Shields provides support for various badges like below

Lets say I want to create a follow badge for my twitter handle. It can be done quickly like this.

I can copy as HTML, MarkDown, etc.

For this blog I copied as HTML and pasted below.

Twitter Follow

Quick view

I have published a npm plugin. I have setup the CI/CD for it. So whenever I commit my changes it will automatically deploy my packages to npm registry.

And also I wants to keep a track of how many downloads happening. So I added badges for those metrics in my repo.

You can find my GitHub Repository below

https://github.com/PandiyanCool/angular-clipboard-auto

Happy Designing!

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