This document outlines the purpose and process of code reviews. Code reviews ensure code quality, proper structure and business logic matching before release. They also serve as a teaching tool for developers to learn better coding techniques. The reviewer's role is to ask questions, provide praise and focus on code, not the coder. Multiple solutions may exist. Developers should see code reviews as helpful feedback, not personal criticism. Reviews are documented and issues tracked electronically. Checklists are used to systematically review coding standards compliance. Next steps include standardizing on a specific coding standard and providing developer training.

1. Code Review
Biju Abraham

2. Purpose
 Make sure that the code that is being
produced has sufficient quality to be released
 Poor structure
 Match business process
 Simple omissions
 Teaching tool to help developers learn when
and how to apply techniques to improve code
quality, consistency, and maintainability
 learn different and potentially better ways of
coding

3. Reviewer - The approach
 Ask questions rather than make statements
 Avoid the "Why" questions
 Remember to praise
 Make sure you have good coding standards to
reference (more to follow)
 Make sure the discussion stays focused on the code
and not the coder
 Remember that there is often more than one way to
approach a solution
 Solutions are the responsibility of the code owner

4. Developer – The Approach
 Remember that the code isn't you
 Create a checklist for yourself of the
things that the code reviews tend to
focus on
 Help to maintain the coding standards

5. Documented Review
 Put a summary comment at the top—
and be positive
 Use an electronic mechanism to record
the comments – Jira
 Make an upfront agreement that not
every question needs to be responded
to

6. Checklist
 Confirm Coding standards
 Confirm business standards (later)
 Unit Testing exists and demonstrated
 Verify dependencies for code change
 Provide code comments

7. Coding Standards - Detailed Checklist
 Interfaces
 Are they as specified by the
design
 Naming convention
 Capitalization

Interface

Parameters
 Comments
 Files
 File names
 Comments
 Organization
 Body of Code
 Declarations

Capitalization

Naming convention (i.e. for global
variables)

Comments

Meaningful names

Single line

Initialization

Placement
 Comments

Function header

Block

Single line

Training
 Statements

Single line

Compound

White lines

Blank spaces
 Other concerns

8. Next Steps
 Standardize on
http://java.sun.com/docs/codeconv/CodeC
 Rong to provide presentation to
Developers on coding standards
 Checklist to be included in Jira soon