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 2006/09/06 19:47:48 UTC
[Lucene-hadoop Wiki] Update of "HowToContribute" by DougCutting
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
The comment on the change is:
note indentation convention & ask folks to check javadoc
------------------------------------------------------------------------------
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].
+ * 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.
* Contributions should pass existing unit tests.
* New unit tests should be provided to demonstrate bugs and fixes ([http://www.junit.org]).
=== Generating a patch ===
+ ==== Unit Tests ====
+
Please make sure that all unit tests succeed before constructing your patch.
-
- ==== Unit Tests ====
{{{
> cd hadoop-trunk
@@ -44, +45 @@
{{{
BUILD FAILED
}}}
- please, read carefully the errors messages and check your code.
+ then please examine error messages in {{{build/test}}} and fix things before proceeding.
+
+ ==== Javadoc ====
+
+ Please also check the javadoc.
+
+ {{{
+ > ant javadoc
+ > firefox build/docs/api/index.html
+ }}}
+
+ Examine all public classes you've changed to see that documentation is complete and informative.
==== Creating a patch ====
Check to see what files you have modified with: