Commit Process Policies

Commit Process Policies

1 Overview

Before committing new code to the SVN repositories, one must first follow some simple rules that will ensure that the committed code will not break the build nor the basic features of the eXo Platform.

Following these following small rules will ensure a much better QA process and will improve the overall productivity of the development teams.

In short, it is not only the responsibility of the Test team to test the software but it is also the duty of each developer before committing.

2 Update before committing

Never commit without updating first!

3 Commit with a comment

Every commit should come with a message telling what you commit is about. The comment should be concise and descriptive. It should also reference an JIRA Issue key.

Here is an exemple :

ECM-2422 Update configuration to match JCR 1.9.x

4 Changing a revision comment

In case a commit has a wrong comment, it is possible to alter it using the following command :

svn propset svn:log <message> -r<revision> --revprop <server>

5 Check the Continuous Build status

As soon as you have committed, tell the Continuous build to build your project. If it fails, you probably have forgotten to add a file.

6 Comments in code

Newly submitted code should be java-commented. Documenting the code is key for adoption of eXo regarding customers and users. In addition, it allows newcomers to understand the product more quickly.

Tags:
Created by Benjamin Mestrallet on 09/24/2007
Last modified by Sören Schmidt on 07/09/2009

Products

generated on Fri Sep 03 00:20:31 UTC 2010

eXo Optional Modules

eXo Core Foundations

Recently Modified


Copyright (c) 2000-2010. All Rights Reserved - eXo platform SAS
2.4.30451