Projects:ProfessionalizingCoding/CodeReview

Overview

This document gives a complete description of the code review process and the code review checklist.

Code Formatting Comments in the code Must-be constructs

Automatic Coding Tools Errors and Warnings setup in Eclipse Code formatting and repair at save

code been formatted using sun's standard java 5 constructs no warning in the code comments in the code itself

Code Review Process

Single Source Code Review Checklist

Java

For java server side code: junit testcases exist and execute correctly.

Each file should have the standard Openbravo copyright notice in the top.

Is your file using a new third-party library or contains copies of source code of someone outside of Openbravo? If yes, check the Intellectual Property Right Checklist.

Is logging used where appropriate?

Is the code commented inline?

Are variable names understandable and correct?

Are constant names correct (uppercased and with _)?

Are getters/setters named correctly?

Advanced points to watch: - synchronized blocks (check for java thread issue) - try/finally blocks where applicable - New Exception classes should inherit OBException

http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html

Datamodel

Project Checklist

code review checklist The project checklist is much more a project plan check list than a code review checklist.

QA: unit test plan exists and have been executed Documentation: the user, configuration and online help

Intellectual Property Right Checklist

This checklist only applies if your code uses a new external library and/or code has been copied from an external (to Openbravo) source into the Openbravo source code.

All files containing Openbravo intellectual property have a standard copyright header. If your project uses a new third party library, product or any other artifact, you have verified that its license is compatible with Openbravo's and this has been verified by Openbravo's legal adviser. If your project uses a new third party library, product or any other artifact, you are respecting the terms of its license and this has been verified by Openbravo's legal adviser. If your project includes third party source code or it is a derivate work of third party source code, the third party contributors have signed a code contributor agreement and agreement has been deposited with Openbravo's Finance department. You are sure that the project does not violate any third party intellectual property.