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, 06 Apr 2006 15:44:26 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

------------------------------------------------------------------------------
  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.
+  * 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].
+  * Contributions should pass existing unit tests.
-  * Provide unit tests to demonstrate bugs and fixes ([http://www.junit.org]).
+  * New unit tests should be provided to demonstrate bugs and fixes ([http://www.junit.org]).
  
  === Generating a patch ===
  
@@ -44, +45 @@

  please, read carefully the errors messages and check your code.
  
  ==== Creating a patch ====
+ Check to see what files you have modified with:
+ {{{
+ svn stat
+ }}}
  
  Add any new files with:
  {{{
@@ -58, +63 @@

  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.
+ This will report all modifications done on Hadoop sources on your local disk and save them
into the ''myBeautifulPath.patch'' file.  Read the 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 it includes ONLY the modifications required to fix a single issue.
+ 
+ Please do not:
+  * reformat code unrelated to the bug being fixed: formatting changes should be separate
patches/commits.
+  * comment out code that is now obsolete: just remove it.  
+  * insert comments around each change, marking the change: folks can use subversion to figure
out what's changed and by whom.
+  * make things public which are not required by end users.
+ 
+ Please do:
+  * try to adhere to the coding style of files you edit;
+  * comment code whose function or rationale is not obvious;
+  * update documentation (e.g., ''package.html'' files, this wiki, etc.)
  
  === Contributing your work ===
  
- 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.
+ 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.  Please incorporate other's suggestions into into
your patch if you think they're reasonable.  Finally, remember that even a patch that is not
committed is useful to the community.
  
  == Stay involved ==
  

Mime
View raw message