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 Wed, 05 Apr 2006 18:43:11 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

------------------------------------------------------------------------------
  svn checkout http://svn.apache.org/repos/asf/lucene/hadoop/trunk/ hadoop-trunk
  }}}
  
+ === Making Changes ===
+ 
+ Before you start, send a message to the [http://lucene.apache.org/hadoop/mailing_lists.html
Hadoop developer mailing list], or file a bug report in [http://issues.apache.org/jira/browse/HADOOP
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.[[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]).
+  * Code should be formatted according to [http://java.sun.com/docs/codeconv/ Sun's conventions].
+  * Provide unit tests to demonstrate bugs and fixes ([http://www.junit.org]).
  
  === Generating a patch ===
  
@@ -40, +45 @@

  
  ==== Creating a patch ====
  
+ Add any new files with:
+ {{{
+ svn add src/.../MyNewClass.java
+ }}}
+ 
+ Edit the ''CHANGES.txt'' file, adding a description of your change, including the bug number
it fixes.
+ 
  In order to create a patch, just type:
  
  {{{
@@ -47, +59 @@

  }}}
  
  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 required to fix a single issue.
 Please do not, e.g., reformat code unrelated to the bug being fixed.
- 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].
+ Finally, patches should be attached to a bug report in [http://issues.apache.org/jira/browse/HADOOP
Jira].  Please be patient.  Committers are busy people too!  If no one responds to your patch
after a few days, please make friendly reminders.
  
  == Stay involved ==
  

Mime
View raw message