What is a code review? and why?
Code review is a common, but an important part of the development process where a fellow peer or a technical person go through the code that you have written to find out issues with it. By reviewing the code we can reduce risks by fixing the issues that the reviewer have found. By doing so we can reduce process of fixing bugs during the later stages, which will save lot of time and money. And by reviewing codes we can share our knowledge on like how others code, and what we are doing wrong in our code. And also it can be a learning material for the junior developers, where they can learn how to apply particular designs and such.What are the thing to look in a code review?
- Code format - A team should have a way of coding like coding practices, line per class, naming conventions, comments. By having this the code will be have consistence, easy to maintain and easy to be learned. (Formatting, Style, Naming and Test coverage this process can be automated)
- Architecture - Does the new code follow the same architecture as the rest of the application
- SOLID Principles - Does the code follow SOLID principles
- Design Pattern - Does the code have appropriate design pattern implemented should be implemented
- Functionality - Does the code to what it suppose to do
- Affecting other functionality - Does the newly added code affect existing functionality.
- Logging - Does the code have necessary logging added
- Documentation - Does the code have documentation
- Testing - Does unit tests covers all the functionalities of the code.
- Readability - Does reading through the code explains about the functionality
These are some of the most important aspects to check when doing a code review. There are many more areas can be checked. And some teams may have different different checklist to be checked in code review. But most importantly code review process is a crutial aspect in development and should be included. By doing so it will save lot of time of the developers and testers and money from the client down the line.
Comments
Post a Comment