hadoop-common-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Lucene-hadoop Wiki] Update of "HowToContribute" by DougCutting
Date Thu, 16 Mar 2006 23:17:14 GMT
Dear Wiki user,

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

The following page has been changed by DougCutting:
http://wiki.apache.org/lucene-hadoop/HowToContribute

New page:
= How to Contribute to Hadoop =

=== Getting the source code ===

First of all, you need the Hadoop source code.[[BR]]

Get the source code on your local drive using [http://lucene.apache.org/hadoop/version_control.html
SVN].  Most development is done on the "trunk":

{{{
svn checkout http://svn.apache.org/repos/asf/lucene/hadoop/trunk/ hadoop-trunk
}}}

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

But take care about the following points
 * All public classes and methods should have informative javadoc.
 * Unit tests are encouraged ([http://www.junit.org]).

=== Generating a patch ===

Please make sure that all unit tests succeed before constructing your patch.

==== Unit Tests ====

{{{
> cd hadoop-trunk
> ant clean test
}}}
After a while, if you see
{{{
BUILD SUCCESSFUL
}}}
all is ok, but if you see
{{{
BUILD FAILED
}}}
please, read carefully the errors messages and check your code.

==== Creating a patch ====

In order to create a patch, just type:

{{{
svn diff > myBeautifulPatch.patch
}}}

This will report all modifications done on Hadoop sources on your local disk and save them
into the ''myBeautifulPath.patch'' file.
Make sure the patch file includes ONLY the modifications you want to add to the Hadoop.  Use
"svn add" to incorporate new files into the patch.


=== Contributing your work ===

Finally, patches should be attached to a bug report in [http://issues.apache.org/jira/browse/HADOOP
Jira].

== Stay involved ==

Contributors should join the [http://lucene.apache.org/hadoop/mailing_lists.html Hadoop 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).

Mime
View raw message