Skip to content

Commit

Permalink
Prepare for release.
Browse files Browse the repository at this point in the history
  • Loading branch information
@garydgregory
garydgregory committed May 15, 2018
1 parent eab5d47 commit 33a38b7
Show file tree
Hide file tree
Showing 5 changed files with 280 additions and 51 deletions.
44 changes: 31 additions & 13 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,48 +50,66 @@ 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 Build Plugin Maven Mojo's scope.
+ Submit a ticket for your issue, assuming one does not already exist.
+ If you're planning to implement a new feature it makes sense to discuss your 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 Build Plugin Maven Mojo's scope.
+ 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. `COMMONSSITE-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. `COMMONSSITE-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 Build Plugin Maven Mojo JIRA project page](https://issues.apache.org/jira/browse/COMMONSSITE)
+ [Apache Commons Build Plugin Maven Mojo 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/)
+ [GitHub pull request documentation](https://help.github.com/articles/creating-a-pull-request/)
+ [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/COMMONSSITE
24 changes: 14 additions & 10 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,18 +43,20 @@
Apache Commons Build Plugin Maven Mojo
===================

Apache Maven Mojo for Apache Commons Build tasks.
[![Build Status](https://travis-ci.org/apache/commons-commons-build-plugin.svg)](https://travis-ci.org/apache/commons-commons-build-plugin)
[![Coverage Status](https://coveralls.io/repos/apache/commons-commons-build-plugin/badge.svg)](https://coveralls.io/r/apache/commons-commons-build-plugin)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-build-plugin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-build-plugin/)
[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-build-plugin/1.9-SNAPSHOT.svg)](https://javadoc.io/doc/org.apache.commons/commons-build-plugin/1.9-SNAPSHOT)

${project.description}

Documentation
-------------

More information can be found on the [homepage](https://commons.apache.org/proper/commons-commons-build-plugin).
More information can be found on the [Apache Commons Build Plugin Maven Mojo homepage](https://commons.apache.org/proper/commons-commons-build-plugin).
The [Javadoc](https://commons.apache.org/proper/commons-commons-build-plugin/javadocs/api-release) can be browsed.
Questions related to the usage of Apache Commons Build Plugin Maven Mojo should be posted to the [user mailing list][ml].

[![Build Status](https://travis-ci.org/apache/commons-build-plugin.svg?branch=trunk)](https://travis-ci.org/apache/commons-build-plugin)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-build-plugin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-build-plugin)

Where can I get the latest release?
-----------------------------------
You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-commons-build-plugin/download_commons-build-plugin.cgi).
Expand All @@ -65,14 +67,14 @@ Alternatively you can pull it from the central Maven repositories:
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-build-plugin</artifactId>
<version>1.7</version>
<version>1.9-SNAPSHOT</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.
Expand All @@ -84,7 +86,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
---------
Expand All @@ -94,8 +98,8 @@ Additional Resources
--------------------

+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/COMMONSSITE)
+ [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
30 changes: 16 additions & 14 deletions src/site/xdoc/download_commons-build-plugin.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,16 @@ limitations under the License.
| - commons.componentid (required, alphabetic, lower case) |
| - commons.release.version (required) |
| - commons.release.name (required) |
| - commons.binary.suffix (optional) |
| - commons.binary.suffix (optional) |
| (defaults to "-bin", set to "" for pre-maven2 releases) |
| - commons.release.desc (optional) |
| - commons.release.subdir (optional) |
| |
| - commons.release.2/3.version (conditional) |
| - commons.release.2/3.name (conditional) |
| - commons.release.2/3.binary.suffix (optional) |
| - commons.release.2/3.desc (optional) |
| - commons.release.2/3.subdir (optional) |
| |
| 3) Example Properties |
| (commons.release.name inherited by parent: |
Expand Down Expand Up @@ -109,32 +111,32 @@ limitations under the License.
</p>
</subsection>
</section>
<section name="Apache Commons Build Plugin Maven Mojo 1.5 ">
<section name="Apache Commons Build Plugin Maven Mojo 1.9-SNAPSHOT ">
<subsection name="Binaries">
<table>
<tr>
<td><a href="[preferred]/commons/commons-build-plugin/binaries/commons-build-plugin-1.5-bin.tar.gz">commons-build-plugin-1.5-bin.tar.gz</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-build-plugin/binaries/commons-build-plugin-1.5-bin.tar.gz.sha1">sha1</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-build-plugin/binaries/commons-build-plugin-1.5-bin.tar.gz.asc">pgp</a></td>
<td><a href="[preferred]/commons/commons-build-plugin/binaries/commons-build-plugin-1.9-SNAPSHOT-bin.tar.gz">commons-build-plugin-1.9-SNAPSHOT-bin.tar.gz</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-build-plugin/binaries/commons-build-plugin-1.9-SNAPSHOT-bin.tar.gz.sha1">sha1</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-build-plugin/binaries/commons-build-plugin-1.9-SNAPSHOT-bin.tar.gz.asc">pgp</a></td>
</tr>
<tr>
<td><a href="[preferred]/commons/commons-build-plugin/binaries/commons-build-plugin-1.5-bin.zip">commons-build-plugin-1.5-bin.zip</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-build-plugin/binaries/commons-build-plugin-1.5-bin.zip.sha1">sha1</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-build-plugin/binaries/commons-build-plugin-1.5-bin.zip.asc">pgp</a></td>
<td><a href="[preferred]/commons/commons-build-plugin/binaries/commons-build-plugin-1.9-SNAPSHOT-bin.zip">commons-build-plugin-1.9-SNAPSHOT-bin.zip</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-build-plugin/binaries/commons-build-plugin-1.9-SNAPSHOT-bin.zip.sha1">sha1</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-build-plugin/binaries/commons-build-plugin-1.9-SNAPSHOT-bin.zip.asc">pgp</a></td>
</tr>
</table>
</subsection>
<subsection name="Source">
<table>
<tr>
<td><a href="[preferred]/commons/commons-build-plugin/source/commons-build-plugin-1.5-src.tar.gz">commons-build-plugin-1.5-src.tar.gz</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-build-plugin/source/commons-build-plugin-1.5-src.tar.gz.sha1">sha1</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-build-plugin/source/commons-build-plugin-1.5-src.tar.gz.asc">pgp</a></td>
<td><a href="[preferred]/commons/commons-build-plugin/source/commons-build-plugin-1.9-SNAPSHOT-src.tar.gz">commons-build-plugin-1.9-SNAPSHOT-src.tar.gz</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-build-plugin/source/commons-build-plugin-1.9-SNAPSHOT-src.tar.gz.sha1">sha1</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-build-plugin/source/commons-build-plugin-1.9-SNAPSHOT-src.tar.gz.asc">pgp</a></td>
</tr>
<tr>
<td><a href="[preferred]/commons/commons-build-plugin/source/commons-build-plugin-1.5-src.zip">commons-build-plugin-1.5-src.zip</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-build-plugin/source/commons-build-plugin-1.5-src.zip.sha1">sha1</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-build-plugin/source/commons-build-plugin-1.5-src.zip.asc">pgp</a></td>
<td><a href="[preferred]/commons/commons-build-plugin/source/commons-build-plugin-1.9-SNAPSHOT-src.zip">commons-build-plugin-1.9-SNAPSHOT-src.zip</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-build-plugin/source/commons-build-plugin-1.9-SNAPSHOT-src.zip.sha1">sha1</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-build-plugin/source/commons-build-plugin-1.9-SNAPSHOT-src.zip.asc">pgp</a></td>
</tr>
</table>
</subsection>
Expand Down
28 changes: 14 additions & 14 deletions src/site/xdoc/issue-tracking.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,35 +43,35 @@ limitations under the License.
-->
<document>
<properties>
<title>commons-build-plugin Maven Mojo Issue tracking</title>
<title>Apache Commons Build Plugin Maven Mojo Issue tracking</title>
<author email="dev@commons.apache.org">Apache Commons Documentation Team</author>
</properties>
<body>

<section name="commons-build-plugin Maven Mojo Issue tracking">
<section name="Apache Commons Build Plugin Maven Mojo Issue tracking">
<p>
commons-build-plugin Maven Mojo uses <a href="http://issues.apache.org/jira/">ASF JIRA</a> for tracking issues.
See the <a href="http://issues.apache.org/jira/browse/COMMONSSITE">commons-build-plugin Maven Mojo JIRA project page</a>.
Apache Commons Build Plugin Maven Mojo uses <a href="https://issues.apache.org/jira/">ASF JIRA</a> for tracking issues.
See the <a href="https://issues.apache.org/jira/browse/COMMONSSITE">Apache Commons Build Plugin Maven Mojo 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-build-plugin Maven Mojo please do the following:
Apache Commons Build Plugin Maven Mojo please do the following:
<ol>
<li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310466&amp;component=12312401&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=1&amp;status=3&amp;status=4">Search existing open bugs</a>.
<li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310466&amp;component=12312401&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=1&amp;status=3&amp;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=12310466&amp;component=12312401&amp;issuetype=1&amp;priority=4&amp;assignee=-1">bug report</a>
or <a href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310466&amp;component=12312401&amp;issuetype=4&amp;priority=4&amp;assignee=-1">enhancement request</a>.</li>
<li>Submit either a <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310466&amp;component=12312401&amp;issuetype=1&amp;priority=4&amp;assignee=-1">bug report</a>
or <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310466&amp;component=12312401&amp;issuetype=4&amp;priority=4&amp;assignee=-1">enhancement request</a>.</li>
</ol>
</p>

Expand All @@ -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-build-plugin Maven Mojo are all unpaid volunteers</li>
<li>the developers of Apache Commons Build Plugin Maven Mojo are all unpaid volunteers</li>
</ul>
</p>

Expand All @@ -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&amp;pid=12310466&amp;component=12312401&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=1&amp;status=3&amp;status=4">All Open commons-build-plugin Maven Mojo bugs</a></li>
<li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310466&amp;component=12312401&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=5&amp;status=6">All Resolved commons-build-plugin Maven Mojo bugs</a></li>
<li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310466&amp;component=12312401&amp;sorter/field=issuekey&amp;sorter/order=DESC">All commons-build-plugin Maven Mojo bugs</a></li>
<li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310466&amp;component=12312401&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=1&amp;status=3&amp;status=4">All Open Apache Commons Build Plugin Maven Mojo bugs</a></li>
<li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310466&amp;component=12312401&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=5&amp;status=6">All Resolved Apache Commons Build Plugin Maven Mojo bugs</a></li>
<li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310466&amp;component=12312401&amp;sorter/field=issuekey&amp;sorter/order=DESC">All Apache Commons Build Plugin Maven Mojo bugs</a></li>
</ul>
</p>
</section>
Expand Down
Loading

0 comments on commit 33a38b7

Please sign in to comment.