Committer Charter for Spring Dynamic Modules project

Submitted by Adrian Colyer on Mon, 2006-10-09 06:07

This page defines the "committers charter" for committers on the Spring Dynamic Modules project.

Use of JIRA

JIRA is used to manage bug reports and feature requests for this project. When working on a new feature or function, please raise a new JIRA issue to cover it (issue type "new feature" or "improvement" as appropriate). This way the other committers know what you are working on, and we have a record of changes made in a release. Please also use JIRA to record and resolve any significant bugs that you find during development.

Develop tests alongside features

New code should not be committed to the repository without also committing corresponding unit (and integration if necessary) tests. How you develop the code and tests prior to commit is up to you!

Process for dealing with bug reports

When working on reported bug in JIRA, please follow the process outlined below:

  1. Accept the issue, so that we know you are working on it.
  2. Create a test case (or test cases) that reproduces the failure in the test suite. Add a comment documenting the issue number the test(s) are associated with.
  3. Now fix the problem....
  4. Add other tests as needed to cover related scenarios
  5. Commit as described in the following section...

Committing code to the repository

The basic process for committing code to the repository is as follows:

  1. Run 'svn update' from the spring-osgi project to ensure you have the very latest version
  2. Run 'mvn clean install' from the spring-osgi project. This should complete without error.
  3. If you've changed any of the site or reporting configuration, also run 'mvn site' from the spring-osgi project
  4. commit your updates
  5. Run 'svn status' (or "check for modifications" in TortoiseSVN) to ensure you have no local changes that remain uncommitted. If you find anything you missed then commit that too!

Intellectual Property

The project uses the Apache 2 License. Please ensure that all source files you commit contain an appropriate copyright and license declaration. You must be sure that you have the rights to any IP contained in a source file before you commit it to the tree.

Build breakages

Build notifications are sent via email from our continuum server. If your commit causes a build breakage (hopefully rare!), please treat fixing the build as the highest priority item.

How do I get commit rights?

Commit rights to the project are earnt by demonstrating a committment to contribute to the project over a period of time through quality patches.