You are viewing a plain text version of this content. The canonical link for it is here.
Posted to solr-commits@lucene.apache.org by Apache Wiki <wi...@apache.org> on 2007/04/30 20:25:22 UTC

[Solr Wiki] Update of "HowToContribute" by HossMan

Dear Wiki user,

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

The following page has been changed by HossMan:
http://wiki.apache.org/solr/HowToContribute

------------------------------------------------------------------------------
  = How to Contribute to Solr =
  
+ This document identifies the ''optimal'' steps community member can take to submit a changes or additions to the Solr code base.  Please note that these are the "optimal" steps, and community members that don't have the time or resources to do everything outlined on this page should not be discouraged from submitting their ideas "as is" per "Yonik's Law of Patches" ...
+ 
+ {{{
+ A half-baked patch in Jira, with no documentation, no tests 
+ and no backwards compatibility is better than no patch at all.
+ }}}
+ 
+ Just because you may not have the time to write Unit tests, or cleanup backwards compatibility issues, or add documentation, doesn't mean other people don't, and put putting your patch out there, other people can try it and improve it.
+ 
+ [[TableOfContents]]
+ 
- === Getting the source code ===
+ == Getting the source code ==
  
  First of all, you need the Solr source code.[[BR]]
  
@@ -13, +24 @@

  > svn checkout https://svn.apache.org/repos/asf/lucene/solr/trunk
  }}}
  
- === Making Changes ===
+ == Making Changes ==
  
  Before you start, you should send a message to the [http://incubator.apache.org/solr/mailing_lists.html Solr developer mailing list] (NOte: you have to subscribe before you can post), or file a bug in [http://issues.apache.org/jira/browse/SOLR 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.
  
@@ -26, +37 @@

   * Contributions should pass existing unit tests.
   * New unit tests should be provided to demonstrate bugs and fixes ([http://www.junit.org]).
  
- === Generating a patch ===
+ == Generating a patch ==
+ 
+ A "patch file" is the format that all good contributions come in.  It bundles up everything that is being added, removed, or changed in your contribution.
+ 
+ === Unit Tests ===
  
  Please make sure that all unit tests succeed before constructing your patch.
- 
- ==== Unit Tests ====
  
  {{{
  > cd solr-trunk
@@ -46, +59 @@

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

   * comment code whose function or rationale is not obvious;
   * update documentation (e.g., ''package.html'' files, this wiki, etc.)
  
- === Contributing your work ===
+ == Contributing your work ==
  
  Finally, patches should be attached to a bug report in [http://issues.apache.org/jira/browse/SOLR Jira].  If you are revising an existing patch, pelase re-use the exact same name as the previous attachment, Jira will "grey out" the older versions so it's clear which version is the newest.