incubator-hama-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Hama Wiki] Update of "HowToContribute" by edwardyoon
Date Thu, 25 Nov 2010 11:44:28 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Hama Wiki" for change notification.

The "HowToContribute" page has been changed by edwardyoon.
http://wiki.apache.org/hama/HowToContribute?action=diff&rev1=4&rev2=5

--------------------------------------------------

  == 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 http://svn.apache.org/repos/asf/incubator/hama/trunk hama-trunk
+ }}}
+ 
+ ==== Git access ====
+ 
+ * git://git.apache.org/hama.git [[http://git.apache.org/hama.git/|HTTP]], [[http://github.com/apache/hama|github]]
+ 
+ === Making Changes ===
+ 
+ Before you start, send a message to the Hama developer mailing list, or file a bug report
in [[https://issues.apache.org/jira/browse/HAMA|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
+ 
+  * All public classes and methods should have informative Javadoc comments.
+  * Code should be formatted according to [[http://incubator.apache.org/hama/hama-eclipse-formatter.xml|hama-code-formatter]]
+  * Contributions should pass existing unit tests.
+  * New unit tests should be provided to demonstrate bugs and fixes. 
+ 
+ === 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
+ > ant clean test docs -Dforrest.home={$FORREST_HOME}
+ }}}
+ 
+ After a while, if you see
+ 
+ {{{
+ BUILD SUCCESSFUL
+ }}}
+ 
+ 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/.../MyNewClass.java
+ }}}
+ 
+ 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).
+ 
+ === See also ===
+ 
+  * [[http://www.apache.org/foundation/voting.html|Apache Voting Documentation]]
+ 

Mime
View raw message