Added by jgarnett, last edited by Adrian Custer on Feb 09, 2008  (view change) show comment

Labels:

osgeo osgeo Delete
Enter labels to add to this page:
Wait Image 
Looking for a label? Just start typing.

Anyone can contribute to the Geotools project by editing the web site, by writing documentation, by answering questions on the email list, or by contributing actual code integrated into the project.

Initially, newcomers to the project generally participate in an informal role. These types of contributors have no long term responsibility to the project.

Easy informal code contributions.

Informal participants can contribute small modifications to the project code by submitting a patch as an attachment to a JIRA task.

The best way to make a code contribution is to develop a formal patch against a checkout of the code from the SVN branch for which the code is being developed. That is, a contributor uses SVN to obtain the code of the branch, edits the files on that checkout, does a full maven build and test to make sure the patch compiles cleanly, and then uses the 'svn diff' command to generate a patch against the branch. Next, the contributor opens a JIRA issue against the subsystem in which the patch was made. The subject of the item should describe the contribution and ideally mention that a patch is attached.

JIRA will automatically notify the maintainer of the module since that is the best person to do the code review. If no one answers or comments in the subsequent few days, then the contributor can contact the developers' mailing list to let everyone know about the patch and find someone else competent to review the code and integrate the contribution into the code base or provide a request for improvements to the patch.

pending

Large contributions

This information is expected to be accepted by the project in the spring of 2008 but has not yet been formally accepted so should be considered as pending.

Informal participants can also contribute larger contributions following essentially the same process as that just described for small code contributions but also including the formal transfer of the copyright over the contribution to the Open Source Geospatial Foundation (OSGeo).

Large contributions such a contributions of new files or significant alterations of the code base raise an additional difficulty for the project since the contributor potentially gains copyright over the collective work. Geotools has adopted a new policy as part of the process of joining the OSGeo Foundation in which all new contributors will be required to transfer copyright to the foundation. This is intended to serve several purposes such as shielding the contributor from a direct legal attach by users of the code, enabling the Foundation to represent the interests of the Geotools project in a legal forum, and enabling the Geotools project to switch licenses when necessary.

For these large contributions, the code patch submitted to the JIRA should include the contributor name in the list of authors of the class documentation for any file in which the contributor has made significant changes. That is the contributor's name should be added using the @author javadoc tag.

The contributor should then print out a copy of the contributor license agreement and send it to the OSGeo foundation as explained in [the next section].