You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by oh...@apache.org on 2017/10/08 11:52:41 UTC
svn commit: r1811479 - in /commons/proper/configuration/trunk:
CONTRIBUTING.md README.md src/site/xdoc/issue-tracking.xml
src/site/xdoc/mail-lists.xml
Author: oheger
Date: Sun Oct 8 11:52:41 2017
New Revision: 1811479
URL: http://svn.apache.org/viewvc?rev=1811479&view=rev
Log:
Updated auto-generated files.
Modified:
commons/proper/configuration/trunk/CONTRIBUTING.md
commons/proper/configuration/trunk/README.md
commons/proper/configuration/trunk/src/site/xdoc/issue-tracking.xml
commons/proper/configuration/trunk/src/site/xdoc/mail-lists.xml
Modified: commons/proper/configuration/trunk/CONTRIBUTING.md
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/CONTRIBUTING.md?rev=1811479&r1=1811478&r2=1811479&view=diff
==============================================================================
--- commons/proper/configuration/trunk/CONTRIBUTING.md (original)
+++ commons/proper/configuration/trunk/CONTRIBUTING.md Sun Oct 8 11:52:41 2017
@@ -51,47 +51,65 @@ Getting Started
+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
+ Make sure you have a [GitHub account](https://github.com/signup/free).
+ If you're planning to implement a new feature it makes sense to discuss you're changes on the [dev list](https://commons.apache.org/mail-lists.html) first. This way you can make sure you're not wasting your time on something that isn't considered to be in Apache Commons Configuration's scope.
-+ Submit a ticket for your issue, assuming one does not already exist.
++ Submit a [Jira Ticket][jira] for your issue, assuming one does not already exist.
+ Clearly describe the issue including steps to reproduce when it is a bug.
+ Make sure you fill in the earliest version that you know has the issue.
-+ Fork the repository on GitHub.
++ Find the corresponding [repository on GitHub](https://github.com/apache/?query=commons-),
+[fork](https://help.github.com/articles/fork-a-repo/) and check out your forked repository.
Making Changes
--------------
-+ Create a topic branch from where you want to base your work (this is usually the master/trunk branch).
++ Create a _topic branch_ for your isolated work.
+ * Usually you should base your branch on the `master` or `trunk` branch.
+ * A good topic branch name can be the JIRA bug id plus a keyword, e.g. `CONFIGURATION-123-InputStream`.
+ * If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
+ Make commits of logical units.
+ * Make sure your commit messages are meaningful and in the proper format. Your commit message should contain the key of the JIRA issue.
+ * e.g. `CONFIGURATION-123: Close input stream earlier`
+ Respect the original code style:
+ Only use spaces for indentation.
- + Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
- + Check for unnecessary whitespace with git diff --check before committing.
-+ Make sure your commit messages are in the proper format. Your commit message should contain the key of the JIRA issue.
-+ Make sure you have added the necessary tests for your changes.
+ + Create minimal diffs - disable _On Save_ actions like _Reformat Source Code_ or _Organize Imports_. If you feel the source code should be reformatted create a separate PR for this change first.
+ + Check for unnecessary whitespace with `git diff` -- check before committing.
++ Make sure you have added the necessary tests for your changes, typically in `src/test/java`.
+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.
Making Trivial Changes
----------------------
+The JIRA tickets are used to generate the changelog for the next release.
+
For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA.
In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number.
+
Submitting Changes
------------------
-+ Sign the [Contributor License Agreement][cla] if you haven't already.
++ Sign and submit the Apache [Contributor License Agreement][cla] if you haven't already.
+ * Note that small patches & typical bug fixes do not require a CLA as
+ clause 5 of the [Apache License](https://www.apache.org/licenses/LICENSE-2.0.html#contributions)
+ covers them.
+ Push your changes to a topic branch in your fork of the repository.
-+ Submit a pull request to the repository in the apache organization.
++ Submit a _Pull Request_ to the corresponding repository in the `apache` organization.
+ * Verify _Files Changed_ shows only your intended changes and does not
+ include additional files like `target/*.class`
+ Update your JIRA ticket and include a link to the pull request in the ticket.
+If you prefer to not use GitHub, then you can instead use
+`git format-patch` (or `svn diff`) and attach the patch file to the JIRA issue.
+
+
Additional Resources
--------------------
+ [Contributing patches](https://commons.apache.org/patches.html)
-+ [Apache Commons Configuration JIRA project page](https://issues.apache.org/jira/browse/CONFIGURATION)
++ [Apache Commons Configuration JIRA project page][jira]
+ [Contributor License Agreement][cla]
+ [General GitHub documentation](https://help.github.com/)
+ [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ #apachecommons IRC channel on freenode.org
++ `#apache-commons` IRC channel on `irc.freenode.net`
[cla]:https://www.apache.org/licenses/#clas
+[jira]:https://issues.apache.org/jira/browse/CONFIGURATION
Modified: commons/proper/configuration/trunk/README.md
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/README.md?rev=1811479&r1=1811478&r2=1811479&view=diff
==============================================================================
--- commons/proper/configuration/trunk/README.md (original)
+++ commons/proper/configuration/trunk/README.md Sun Oct 8 11:52:41 2017
@@ -43,10 +43,13 @@
Apache Commons Configuration
===================
-[](https://travis-ci.org/apache/commons-configuration)
+[](https://travis-ci.org/apache/commons-configuration2)
+[](https://coveralls.io/r/apache/commons-configuration2)
[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-configuration2/)
+[](http://www.apache.org/licenses/LICENSE-2.0.html)
-Tools to assist in the reading of configuration/preferences files in various formats
+Tools to assist in the reading of configuration/preferences files in
+ various formats
Documentation
-------------
@@ -65,7 +68,7 @@ Alternatively you can pull it from the c
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-configuration2</artifactId>
- <version>2.1.1</version>
+ <version>2.2</version>
</dependency>
```
Modified: commons/proper/configuration/trunk/src/site/xdoc/issue-tracking.xml
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/site/xdoc/issue-tracking.xml?rev=1811479&r1=1811478&r2=1811479&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/site/xdoc/issue-tracking.xml (original)
+++ commons/proper/configuration/trunk/src/site/xdoc/issue-tracking.xml Sun Oct 8 11:52:41 2017
@@ -43,35 +43,35 @@ limitations under the License.
-->
<document>
<properties>
- <title>Commons Configuration Issue tracking</title>
- <author email="dev@commons.apache.org">Commons Documentation Team</author>
+ <title>Apache Commons Configuration Issue tracking</title>
+ <author email="dev@commons.apache.org">Apache Commons Documentation Team</author>
</properties>
<body>
- <section name="Commons Configuration Issue tracking">
+ <section name="Apache Commons Configuration Issue tracking">
<p>
- Commons Configuration uses <a href="http://issues.apache.org/jira/">ASF JIRA</a> for tracking issues.
- See the <a href="http://issues.apache.org/jira/browse/CONFIGURATION">Commons Configuration JIRA project page</a>.
+ Apache Commons Configuration uses <a href="https://issues.apache.org/jira/">ASF JIRA</a> for tracking issues.
+ See the <a href="https://issues.apache.org/jira/browse/CONFIGURATION">Apache Commons Configuration JIRA project page</a>.
</p>
<p>
- To use JIRA you may need to <a href="http://issues.apache.org/jira/secure/Signup!default.jspa">create an account</a>
+ To use JIRA you may need to <a href="https://issues.apache.org/jira/secure/Signup!default.jspa">create an account</a>
(if you have previously created/updated Commons issues using Bugzilla an account will have been automatically
- created and you can use the <a href="http://issues.apache.org/jira/secure/ForgotPassword!default.jspa">Forgot Password</a>
+ created and you can use the <a href="https://issues.apache.org/jira/secure/ForgotPassword!default.jspa">Forgot Password</a>
page to get a new password).
</p>
<p>
If you would like to report a bug, or raise an enhancement request with
- Commons Configuration please do the following:
+ Apache Commons Configuration please do the following:
<ol>
- <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310467&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">Search existing open bugs</a>.
+ <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310467&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">Search existing open bugs</a>.
If you find your issue listed then please add a comment with your details.</li>
<li><a href="mail-lists.html">Search the mailing list archive(s)</a>.
You may find your issue or idea has already been discussed.</li>
<li>Decide if your issue is a bug or an enhancement.</li>
- <li>Submit either a <a href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310467&issuetype=1&priority=4&assignee=-1">bug report</a>
- or <a href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310467&issuetype=4&priority=4&assignee=-1">enhancement request</a>.</li>
+ <li>Submit either a <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310467&issuetype=1&priority=4&assignee=-1">bug report</a>
+ or <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310467&issuetype=4&priority=4&assignee=-1">enhancement request</a>.</li>
</ol>
</p>
@@ -80,7 +80,7 @@ limitations under the License.
<ul>
<li>the more information you provide, the better we can help you</li>
<li>test cases are vital, particularly for any proposed enhancements</li>
- <li>the developers of Commons Configuration are all unpaid volunteers</li>
+ <li>the developers of Apache Commons Configuration are all unpaid volunteers</li>
</ul>
</p>
@@ -92,9 +92,9 @@ limitations under the License.
<p>
You may also find these links useful:
<ul>
- <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310467&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">All Open Commons Configuration bugs</a></li>
- <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310467&sorter/field=issuekey&sorter/order=DESC&status=5&status=6">All Resolved Commons Configuration bugs</a></li>
- <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310467&sorter/field=issuekey&sorter/order=DESC">All Commons Configuration bugs</a></li>
+ <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310467&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">All Open Apache Commons Configuration bugs</a></li>
+ <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310467&sorter/field=issuekey&sorter/order=DESC&status=5&status=6">All Resolved Apache Commons Configuration bugs</a></li>
+ <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310467&sorter/field=issuekey&sorter/order=DESC">All Apache Commons Configuration bugs</a></li>
</ul>
</p>
</section>
Modified: commons/proper/configuration/trunk/src/site/xdoc/mail-lists.xml
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/site/xdoc/mail-lists.xml?rev=1811479&r1=1811478&r2=1811479&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/site/xdoc/mail-lists.xml (original)
+++ commons/proper/configuration/trunk/src/site/xdoc/mail-lists.xml Sun Oct 8 11:52:41 2017
@@ -41,14 +41,14 @@ limitations under the License.
-->
<document>
<properties>
- <title>Commons Configuration Mailing Lists</title>
- <author email="dev@commons.apache.org">Commons Documentation Team</author>
+ <title>Apache Commons Configuration Mailing Lists</title>
+ <author email="dev@commons.apache.org">Apache Commons Documentation Team</author>
</properties>
<body>
<section name="Overview">
<p>
- <a href="index.html">Commons Configuration</a> shares mailing lists with all the other
+ <a href="index.html">Apache Commons Configuration</a> shares mailing lists with all the other
<a href="http://commons.apache.org/components.html">Commons Components</a>.
To make it easier for people to only read messages related to components they are interested in,
the convention in Commons is to prefix the subject line of messages with the component's name,
@@ -58,24 +58,27 @@ limitations under the License.
</ul>
</p>
<p>
- Questions related to the usage of Commons Configuration should be posted to the
+ Questions related to the usage of Apache Commons Configuration should be posted to the
<a href="http://mail-archives.apache.org/mod_mbox/commons-user/">User List</a>.
<br />
The <a href="http://mail-archives.apache.org/mod_mbox/commons-dev/">Developer List</a>
- is for questions and discussion related to the development of Commons Configuration.
+ is for questions and discussion related to the development of Apache Commons Configuration.
<br />
Please do not cross-post; developers are also subscribed to the user list.
+ <br />
+ You must be subscribed to post to the mailing lists. Follow the Subscribe links below
+ to subscribe.
</p>
<p>
<strong>Note:</strong> please don't send patches or attachments to any of the mailing lists.
- Patches are best handled via the <a href="issue-tracking.html">Issue Tracking</a> system.
- Otherwise, please upload the file to a public server and include the URL in the mail.
+ Patches are best handled via the <a href="issue-tracking.html">Issue Tracking</a> system.
+ Otherwise, please upload the file to a public server and include the URL in the mail.
</p>
</section>
- <section name="Commons Configuration Mailing Lists">
+ <section name="Apache Commons Configuration Mailing Lists">
<p>
- <strong>Please prefix the subject line of any messages for <a href="index.html">Commons Configuration</a>
+ <strong>Please prefix the subject line of any messages for <a href="index.html">Apache Commons Configuration</a>
with <i>[configuration]</i></strong> - <i>thanks!</i>
<br />
<br />
@@ -96,7 +99,7 @@ limitations under the License.
<td>
<strong>Commons User List</strong>
<br /><br />
- Questions on using Commons Configuration.
+ Questions on using Apache Commons Configuration.
<br /><br />
</td>
<td><a href="mailto:user-subscribe@commons.apache.org">Subscribe</a></td>
@@ -114,7 +117,7 @@ limitations under the License.
<td>
<strong>Commons Developer List</strong>
<br /><br />
- Discussion of development of Commons Configuration.
+ Discussion of development of Apache Commons Configuration.
<br /><br />
</td>
<td><a href="mailto:dev-subscribe@commons.apache.org">Subscribe</a></td>
@@ -185,10 +188,10 @@ limitations under the License.
General announcements of Apache project releases.
<br /><br />
</td>
- <td><a class="externalLink" href="mailto:announce-subscribe@apache.org">Subscribe</a></td>
- <td><a class="externalLink" href="mailto:announce-unsubscribe@apache.org">Unsubscribe</a></td>
+ <td><a class="externalLink" href="mailto:announce-subscribe@apache.org">Subscribe</a></td>
+ <td><a class="externalLink" href="mailto:announce-unsubscribe@apache.org">Unsubscribe</a></td>
<td><i>read only</i></td>
- <td><a class="externalLink" href="http://mail-archives.apache.org/mod_mbox/www-announce/">mail-archives.apache.org</a></td>
+ <td><a class="externalLink" href="http://mail-archives.apache.org/mod_mbox/www-announce/">mail-archives.apache.org</a></td>
<td><a class="externalLink" href="http://markmail.org/list/org.apache.announce/">markmail.org</a><br />
<a class="externalLink" href="http://old.nabble.com/Apache-News-and-Announce-f109.html">old.nabble.com</a><br />
<a class="externalLink" href="http://www.mail-archive.com/announce@apache.org/">www.mail-archive.com</a><br />