Free Live Demo

Please complete the contact form for a complimentary assessment of your current workforce management processes, and to learn how Celayix can help you better manage your organization.
An advisor will be in touch with you shortly or you can contact us toll free 1-888-591-5558

First Name*

Last Name*

Company*

Business Phone*

Email*

Message

Your information will not be shared or sold to third parties under any circumstances.

Blog

The Importance of Code Review

September 12, 2017

Author: Ryan Io

As software development projects get larger, code reviews becomes increasingly important to maintain quality in the product, especially staff scheduling software. Peer review is a step that ensures that the new code being submitted does not break existing functionality and the code follows standard guidelines. It is also a learning opportunity for the developer whose code is in review.

Here are some general practices to try to employ while doing code reviews: Rather than only looking for syntax errors and such, a reviewer should also look for issues such as the readability of code, which includes the use of comments and clear function naming.

A developer should make the code as understandable as possible by using small, clear functions with proper naming. For complex pieces of code, if this is not possible, adding comments to code which is unclear will help with readability and longer term maintainability. As a reviewer, comments on the piece of code should state what needs to be changed and should explain why it needs to be changed.

To help reviewers out developers can use proper commit names which clearly explain what the code is doing rather than leaving short messages such as “fixed issue.” Links to information about the task will also help reviewers understand what the purpose of the code being submitted is.

As a developer having their code reviewed, comments posted during code reviews can sound aggressive, but it is important to understand that these comments are to ensure quality in the code and are never personal.

Related Articles

The Changing Security Landscape Security is a labor-intensive, high turnover, low margin business. Covering shifts effectively depends on both good planning and effective management of last minute (short-notice) changes. To...