How to Contribute To Hama

Getting the source code

First of all, you need the Hama source code. The official location for Hama is the Apache SVN repository; Git is also supported, and useful if you want to make lots of local changes -and keep those changes under some form or private or public revision control.

SVN access

Get the source code on your local drive using SVN. Most development is done on the TRUNK:

svn checkout hama-trunk

Git access

* git:// HTTP, github

Making Changes

Before you start, send a message to the Hama developer mailing list, or file a bug report in Jira. Describe your proposed changes and check that they fit in with what others are doing and have planned for the project. Be patient, it may take folks a while to understand your requirements.

Modify the source code and add some (very) nice features using your favorite IDE.

But take care about the following points

Generating a patch

Please make sure that all unit tests succeed before constructing your patch and that no new javac compiler warnings are introduced by your patch.

> cd hama-trunk
> mvn install package

# build examples jar file
> mvn -Pexamples package
# build website
> mvn -Pforrest package -Dforrest.home={$FORREST_HOME}

After a while, if you see


all is OK.

Creating a patch

Check to see what files you have modified with:

svn stat

Add any new files with:

svn add src/.../

In order to create a patch, type (from the root directory of hama):

svn diff > HAMA-321.patch

This will report all modifications done on Hama sources on your local disk and save them into the HAMA-321.patch file. Read the patch file. Make sure it includes ONLY the modifications required to fix a single issue.

Stay involved

Contributors should join the Hama mailing lists. In particular, the commit list (to see changes as they are made), the dev list (to join discussions of changes) and the user list (to help others).

Coding convention

See also