Author: ltheussl
Date: Fri Jan 20 11:07:24 2006
New Revision: 370882
URL: http://svn.apache.org/viewcvs?rev=370882&view=rev
Log:
Add checklist for submitting patches
Modified:
maven/maven-1/core/trunk/xdocs/contributing/patches.xml
Modified: maven/maven-1/core/trunk/xdocs/contributing/patches.xml
URL:
http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/contributing/patches.xml?rev=370882&r1=370881&r2=370882&view=diff
==============================================================================
--- maven/maven-1/core/trunk/xdocs/contributing/patches.xml (original)
+++ maven/maven-1/core/trunk/xdocs/contributing/patches.xml Fri Jan 20 11:07:24
2006
@@ -49,11 +49,60 @@
<p>
Prepare the patch by going to the top level of the checkout (the
<code>trunk</code>), and running:
</p>
- <source>svn diff >ISSUE-NUMBER.txt</source>
+ <source>svn diff >ISSUE-NUMBER.patch</source>
<p>
Replace ISSUE-NUMBER in the filename with the actual ticket number in
the issue tracking system.
Finally, attach the file to the issue tracking system as an attachment.
</p>
+ <subsection name="Checklist">
+ <p>
+ Here is a quick checklist for submitting patches. By complying to
these
+ points, you make it easier for committers to review your patch and
+ therefore you increase the chances that it gets applied quickly.
+ </p>
+ <dl>
+ <dt>Documentation</dt>
+ <dd>
+ Update the documentation. This is especially important for new
features
+ and behavioural changes. For bug fixes you should at least put an
entry
+ into the <code>xdocs/changes.xml</code> file.
+ </dd>
+ <dt>Tests</dt>
+ <dd>
+ Include test cases. Committers don't always have the resources to
check
+ whether your patch actually works. Test cases are helpful by
showing
+ what your patch is actually supposed to do.
+ </dd>
+ <dt>Conventions</dt>
+ <dd>
+ Comply with the Maven
+ <a href="http://maven.apache.org/developers/code-style.html";>code
style</a>
+ and other <a href="../reference/conventions.html">conventions</a>.
+ </dd>
+ <dt>Compatibility</dt>
+ <dd>
+ Make sure your patch doesn't break anything in other parts of
Maven.
+ Ideally you would run a complete
+ <a href="../developers/building-from-source.html">bootstrap</a> to
+ check that no test cases are broken.
+ </dd>
+ <dt>License</dt>
+ <dd>
+ Review the licenses. For any files that you add, make sure that you
+ are actually allowed to do so and document it. By submitting a
patch
+ to Maven, you implicitly agree to put it under the
+ <a href="../license.html">ASL2</a> license.
+ </dd>
+ <dt>Stay informed</dt>
+ <dd>
+ Follow the status of your issue. If you do not regularly read the
mailing lists,
+ it is important that you 'watch' the JIRA issue where you attached
your patch
+ (there is a 'Watch it' link on the left-side menu). Like that you
will
+ be notified of any changes or updates regarding the issue and
committers
+ can contact you if they have any questions.
+ </dd>
+ </dl>
+ </subsection>
</section>
</body>
</document>
