Code review checklist

In our blog about effective code reviews , we recommended the use of a checklist. Checklists are a great tool in code reviews – they ensure that reviews are consistently performed throughout your team. This is part three of the series on improving efficiency of code review process in my team.

The purpose of this article is to propose an ideal and simple checklist that can be used for code review for most languages. Even though there are a lot of code review techniques available everywhere along with how to write good code and how to handle bias while reviewing, etc. This blog serves as a great starting point for code reviewers by exploring code review checklist.

Helping code reviewers to perform effective code reviews. Review Information: Name of Reviewer: Name of Coder: File(s) under review : Brief description of change being reviewed: Review Notes (problems or decisions):. SVN Versions (if applicable):. Utilize this checklist to review the quality of your Java code , including security, performance, and static code analysis.

All errors which are relatively easy to check must be checked: error conditions like “open() failed after stat() was successfull” or “array size greater then INT_MAX” may be ignored for being just as unlikely as uneasy to test, but otherwise having bugs in code which does error handling is way too common to . Things to look for during a code review. Code review is a process to review existing code and learn from it, not the time or place to discuss design ideas. If design ideas come to min write them down separately and discuss them outside of the code review.

My team uses a code review checklist to prevent stupid mistakes from causing us problems and wasting time. Is all the code easily understood? These will usually cover location of braces, variable and function names, line length, indentations, formatting, and. Does it conform to your agreed coding conventions? Design and Code Review Checklist.

This checklist – compiled by our senior software development consultants - provides a comprehensive compilation of design and code review principles and guidelines. Generic Checklist for Code Reviews. Is the code well-structure consistent in style, and consistently formatted? Does the code conform to any pertinent coding standards?

Are there any uncalled or unneeded procedures or any unreachable code . Giving negative feedback. In Part of the Code Review series, we shared best practices for performing code peer review that has proven to be effective when delivering Oro applications. Today we share our code review checklist that you can use when preparing for the code inspection.

It will help you determine if the code is . This document is for anyone who want to contribute code to the khmer project, and describes our coding standards and code review checklist. Coding guidelines and code review checklist ¶. Can the code be made simpler while still doing what it needs to do?

Are available building blocks used when appropriate?