Commit Policies

Before committing new code to the SVN repositories, one must first follow some simple rules that will insure the commit will not break the build nor the basic features of the platform.

this small rules will unsure a much better QA process and will improve the overall productivity of the development teams.

In one word, it is not only the responsibility of the Test team to test the software but it is also the duty of each developer before he commits.

Update the last source before committing

Never commit without updating first!

Run a "sniff test"

A sniff test is a small test that include very basic test case which basically contains 30 operations on the portal. This sniff tests is updated by the Test team

A sniff test is the MINIMUM set of test a DEVELOPER must check before committing

Here is it: Sniff Test

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

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.

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 quickly the product.


Creator: Benjamin Mestrallet on 2007/09/24 22:59
Copyright (c) 2000-2009. Allright reserved - eXo platform SAS
1.6.13286