Update auto generated files
Project: http://git-wip-us.apache.org/repos/asf/commons-io/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-io/commit/3075f1d1 Tree: http://git-wip-us.apache.org/repos/asf/commons-io/tree/3075f1d1 Diff: http://git-wip-us.apache.org/repos/asf/commons-io/diff/3075f1d1 Branch: refs/heads/release Commit: 3075f1d1bf511f485d1addebf52f499f6f792518 Parents: ca830c6 Author: Benedikt Ritter <brit...@apache.org> Authored: Sat Sep 30 16:19:56 2017 +0200 Committer: Benedikt Ritter <brit...@apache.org> Committed: Sat Sep 30 16:30:16 2017 +0200 ---------------------------------------------------------------------- CONTRIBUTING.md | 40 +++++++++++++++++++++++++---------- README.md | 22 +++++++++++-------- src/site/xdoc/issue-tracking.xml | 30 +++++++++++++------------- 3 files changed, 57 insertions(+), 35 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-io/blob/3075f1d1/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 11e9dd7..bd76d94 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 IO'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. `IO-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. `IO-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 IO JIRA project page](https://issues.apache.org/jira/browse/IO) ++ [Apache Commons IO 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/IO http://git-wip-us.apache.org/repos/asf/commons-io/blob/3075f1d1/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index fc28d5f..3417ae4 100644 --- a/README.md +++ b/README.md @@ -44,15 +44,17 @@ Apache Commons IO =================== [](https://travis-ci.org/apache/commons-io) -[](https://coveralls.io/github/apache/commons-io?branch=master) +[](https://coveralls.io/r/apache/commons-io) +[](https://maven-badges.herokuapp.com/maven-central/commons-io/commons-io/) +[](http://www.apache.org/licenses/LICENSE-2.0.html) -The Apache Commons IO library contains utility classes, stream implementations, file filters, +The Apache Commons IO library contains utility classes, stream implementations, file filters, file comparators, endian transformation classes, and much more. Documentation ------------- -More information can be found on the [homepage](https://commons.apache.org/proper/commons-io). +More information can be found on the [Apache Commons IO homepage](https://commons.apache.org/proper/commons-io). The [JavaDoc](https://commons.apache.org/proper/commons-io/javadocs/api-release) can be browsed. Questions related to the usage of Apache Commons IO should be posted to the [user mailing list][ml]. @@ -66,14 +68,14 @@ Alternatively you can pull it from the central Maven repositories: <dependency> <groupId>commons-io</groupId> <artifactId>commons-io</artifactId> - <version>2.5</version> + <version>2.6</version> </dependency> ``` Contributing ------------ -We accept PRs via github. The [developer mailing list][ml] is the main channel of communication for contributors. +We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors. There are some guidelines which will make applying PRs easier for us: + No tabs! Please use spaces for indentation. + Respect the code style. @@ -85,7 +87,9 @@ You can learn more about contributing via GitHub in our [contribution guidelines License ------- -Code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0.txt). +This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0). + +See the `NOTICE.txt` file for required notices and attributions. Donations --------- @@ -94,9 +98,9 @@ You like Apache Commons IO? Then [donate back to the ASF](https://www.apache.org Additional Resources -------------------- -+ [Apache Commons IO Homepage](https://commons.apache.org/proper/commons-io/) -+ [Apache Commons IO Bugtracker (JIRA)](https://issues.apache.org/jira/browse/IO) ++ [Apache Commons Homepage](https://commons.apache.org/) ++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/IO) + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) -+ #apachecommons IRC channel on freenode.org ++ `#apache-commons` IRC channel on `irc.freenode.org` [ml]:https://commons.apache.org/mail-lists.html http://git-wip-us.apache.org/repos/asf/commons-io/blob/3075f1d1/src/site/xdoc/issue-tracking.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/issue-tracking.xml b/src/site/xdoc/issue-tracking.xml index 9e05944..6b0c6d6 100644 --- a/src/site/xdoc/issue-tracking.xml +++ b/src/site/xdoc/issue-tracking.xml @@ -43,35 +43,35 @@ limitations under the License. --> <document> <properties> - <title>Commons IO Issue tracking</title> - <author email="d...@commons.apache.org">Commons Documentation Team</author> + <title>Apache Commons IO Issue tracking</title> + <author email="d...@commons.apache.org">Apache Commons Documentation Team</author> </properties> <body> - <section name="Commons IO Issue tracking"> + <section name="Apache Commons IO Issue tracking"> <p> - Commons IO uses <a href="http://issues.apache.org/jira/";>ASF JIRA</a> for tracking issues. - See the <a href="http://issues.apache.org/jira/browse/IO";>Commons IO JIRA project page</a>. + Apache Commons IO uses <a href="https://issues.apache.org/jira/";>ASF JIRA</a> for tracking issues. + See the <a href="https://issues.apache.org/jira/browse/IO";>Apache Commons IO 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 IO please do the following: + Apache Commons IO please do the following: <ol> - <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310477&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=12310477&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=12310477&issuetype=1&priority=4&assignee=-1";>bug report</a> - or <a href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310477&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=12310477&issuetype=1&priority=4&assignee=-1";>bug report</a> + or <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310477&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 IO are all unpaid volunteers</li> + <li>the developers of Apache Commons IO 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=12310477&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>All Open Commons IO bugs</a></li> - <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310477&sorter/field=issuekey&sorter/order=DESC&status=5&status=6";>All Resolved Commons IO bugs</a></li> - <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310477&sorter/field=issuekey&sorter/order=DESC";>All Commons IO bugs</a></li> + <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310477&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>All Open Apache Commons IO bugs</a></li> + <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310477&sorter/field=issuekey&sorter/order=DESC&status=5&status=6";>All Resolved Apache Commons IO bugs</a></li> + <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310477&sorter/field=issuekey&sorter/order=DESC";>All Apache Commons IO bugs</a></li> </ul> </p> </section>
