Author: bayard
Date: Mon Mar 29 03:17:14 2010
New Revision: 928580
URL: http://svn.apache.org/viewvc?rev=928580&view=rev
Log:
Removing the 'post patch to mail list' alternative. Keep it simple.
Modified:
commons/proper/commons-site/trunk/src/site/xdoc/patches.xml
Modified: commons/proper/commons-site/trunk/src/site/xdoc/patches.xml
URL:
http://svn.apache.org/viewvc/commons/proper/commons-site/trunk/src/site/xdoc/patches.xml?rev=928580&r1=928579&r2=928580&view=diff
==============================================================================
--- commons/proper/commons-site/trunk/src/site/xdoc/patches.xml (original)
+++ commons/proper/commons-site/trunk/src/site/xdoc/patches.xml Mon Mar 29
03:17:14 2010
@@ -111,49 +111,29 @@
</section>
<section name="Submitting A Patch">
<p>
- There are two ways to submit a patch:
- <ul>
- <li>
- By adding the patch as an attachment to a bug report. Apache Commons
projects
- use the <a href='https://issues.apache.org/jira/'>Apache JIRA Bug
Tracker</a>.
- </li>
- <li>
- By mailing the patch as an attachment to the
- <a href='mail-lists.html'>dev mailing list</a>.
- The email subject should describe what the patch does and should be
prefixed
- by <code>[PATCH]</code>. Make sure that it's clear which component the
patch is for.
- Ideally the component name should be the next word after
<code>[PATCH]</code>.
- </li>
- </ul>
- </p>
- <p>
- <em>But which way is better?</em> Please use JIRA, patches sent to the
mailing lists are
- hard to track unless they are immediately acted upon!
- </p>
- <p>If it's a big patch
- then adding it to a bug report will save bandwidth on the mailing list (but
remember
- to include the url in any follow-up discussions). Using a bug report also
allows you to
- be automatically posted with status updates. Note that new bug reports (and
comments on
- existing ones) automatically get mailed to the issues email list so there's
no
- need to post a separate email indicating that the patch has been created.
- </p>
- <p>
- If the patch is a fix for a bug that's already been reported then it's best
to add it as an
- attachment to the bug report. This not only makes management easier but also
it stops other
- developers out there wasting their time by developing independent fixes!
+ Please use JIRA, patches sent to the mailing lists are harder to track and
use up more bandwidth.
</p>
<p>
- If there has already been discussion of the issue on the dev mailing list
(but no JIRA
- entry has been created), then posting the patch direct to the mailing list
can be simpler.
+ Apache Commons projects use the main <a
href='https://issues.apache.org/jira/'>Apache JIRA Bug Tracker</a>.
+ Each released project has its own JIRA page, while those in the Sandbox
share a single JIRA
+ <a href="https://issues.apache.org/jira/browse/SANDBOX";>SANDBOX page</a>.
To find a released project's
+ JIRA page, go to its website and choose the Issue Tracking navigation
link.
</p>
<p>
- In any case, please give a detailed description of what your patch does and
some reasons
+ Please give a detailed description of what your patch does and some reasons
why it should be committed (if it's not obvious).
+ Add the patch as an attachment to a bug report, either a new one or if you
find an existing report
+ then attach it there. Both will result in an email being sent to the issues
email list.
+ </p>
+ <p>
+ If there has already been discussion of the issue on the dev mailing list
(but no JIRA
+ entry has been created), you may wish to make a note on that discussion
thread that you
+ have created a new issue.
</p>
<p>
All the commons documentation is in the commons version control system -
including this document.
If you see anything that's wrong or you think that you can add something
that's missing then
- please submit a patch!
+ please submit a patch to <a
href="https://issues.apache.org/jira/browse/COMMONSSITE";>JIRA</a>!
</p>
<p>
<strong>TIA</strong>
