You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-commits@hadoop.apache.org by Apache Wiki <wi...@apache.org> on 2007/02/28 08:07:59 UTC
[Lucene-hadoop Wiki] Update of "HowToContribute" by NigelDaley
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 NigelDaley:
http://wiki.apache.org/lucene-hadoop/HowToContribute
The comment on the change is:
Added a few unit test guidelines and requirements around javac/javadoc warnings
------------------------------------------------------------------------------
But take care about the following points
* All public classes and methods should have informative [http://java.sun.com/j2se/javadoc/writingdoccomments/ Javadoc comments].
* Code should be formatted according to [http://java.sun.com/docs/codeconv/ Sun's conventions], with one exception:
- * indent two spaces per level, not four.
+ * Indent two spaces per level, not four.
* Contributions should pass existing unit tests.
* New unit tests should be provided to demonstrate bugs and fixes ([http://www.junit.org]).
+ * By default, do not let tests write any temporary files to /tmp. Instead, the tests should write to the location specified by the {{{test.build.data}}} system property.
+ * If a HDFS cluster or a Mapreduce cluster is needed by your test, please use {{{org.apache.hadoop.dfs.MiniDFSCluster}}} and {{{org.apache.hadoop.mapred.MiniMRCluster}}}, respectively.
=== Generating a patch ===
==== Unit Tests ====
- Please make sure that all unit tests succeed before constructing your 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 hadoop-trunk
- > ant clean test
+ > ant -Djavac.args="-Xlint -Xmaxwarns 1000" clean test tar
}}}
After a while, if you see
{{{
@@ -56, +58 @@
> firefox build/docs/api/index.html
}}}
- Examine all public classes you've changed to see that documentation is complete and informative.
+ Examine all public classes you've changed to see that documentation is complete and informative. Your patch must not generate any javadoc warnings.
==== Creating a patch ====
Check to see what files you have modified with: