commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject svn commit: r922127 - /commons/proper/commons-site/src/site/xdoc/patches.xml
Date Fri, 12 Mar 2010 03:02:48 GMT
Author: sebb
Date: Fri Mar 12 03:02:48 2010
New Revision: 922127

URL: http://svn.apache.org/viewvc?rev=922127&view=rev
Log:
Tweaks

Modified:
    commons/proper/commons-site/src/site/xdoc/patches.xml

Modified: commons/proper/commons-site/src/site/xdoc/patches.xml
URL: http://svn.apache.org/viewvc/commons/proper/commons-site/src/site/xdoc/patches.xml?rev=922127&r1=922126&r2=922127&view=diff
==============================================================================
--- commons/proper/commons-site/src/site/xdoc/patches.xml (original)
+++ commons/proper/commons-site/src/site/xdoc/patches.xml Fri Mar 12 03:02:48 2010
@@ -25,7 +25,7 @@
  <body>
   <section name="On Contributing Patches">
   <p>
-  The commons gets a fair number of submissions from developers new to contributing patches.
+  Apache Commons gets a fair number of submissions from developers new to contributing patches.
   A lot of information to help you do this exists, but it can be hard to find.
   This document gathers up material about patches into one handy reference.
   </p>
@@ -65,12 +65,17 @@
   have to reformat it before it's applied or the patch will be rejected. Again, it's easier

   to get it right in the first place rather than have to reformat and resubmit your patch.
   </p>
+  <p>
+  Please try and restrict patches to the minimum necessary to implement the change.
+  If there are a lot of irrelevant formatting or other changes, it make it much harder to
review
+  the patch, and it may be rejected.
+  </p>
   </subsection>
   </section>
   <section name="Test Cases">
   <p>
-  Components in the commons use <a href='http://www.junit.org/index.html'>JUnit</a>
for unit 
-  testing. If you're not familiar with the principles of regression testing, then the JUnit
site 
+  Commons Components use <a href='http://www.junit.org/index.html'>JUnit</a>
for unit 
+  testing. If you're not familiar with the principles of unit testing, then the JUnit site

   has some <a href='http://www.junit.org/taxonomy/term/12'>good articles</a>.
   </p>
   <p>
@@ -82,6 +87,8 @@
   We strongly recommend that you create and submit test cases together with the rest of your

   contribution. Test cases ensure that bugs stay fixed and features don't get broken.  Test
cases 
   will probably be needed anyway so submitting them saves time.
+  If your patch is intended to fix a bug, it helps to create a unit test for the bug first.
+  Test with this before and after applying the fix.
   </p>
   </section>
   <section name="Creating A Patch">
@@ -97,7 +104,7 @@
   </p>
   <p>
   The patch should be in unified format. You can create a patch in this format (from Subversion)
by using:
-  <source>svn diff <em>File</em> >> <em>patchfile</em></source><br/>
+  <source>svn diff <em>File</em> > <em>patchfile</em></source><br/>
   Try to give your patch files meaningful names. This makes it easier for developers who
need to 
   apply a number of different patches. 
   </p>



Mime
View raw message