resources.commons-xdoc-templates.readme-md-template.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commons-build-plugin Show documentation

Apache Maven Mojo for Apache Commons Build tasks. For example: mvn commons-build:download-page [-Dcommons.release.version=1.2.3] To use a SNAPSHOT version (for testing etc) mvn org.apache.commons:commons-build-plugin:1.14.0-SNAPSHOT:download-page [-Dcommons.release.version=1.2.3]

There is a newer version: 1.14.1

Show newest version



@NAME@
===================

[![Build Status](https://travis-ci.org/apache/@[email protected]?branch=master)](https://travis-ci.org/apache/@ARTIFACTCOREID@)
[![Coverage Status](https://coveralls.io/repos/apache/@ARTIFACTCOREID@/badge.svg?branch=master)](https://coveralls.io/r/apache/@ARTIFACTCOREID@)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/@GROUPID@/@ARTIFACTCOREID@/badge.svg)](https://maven-badges.herokuapp.com/maven-central/@GROUPID@/@ARTIFACTCOREID@/)
[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)

@DESCRIPTION@

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

More information can be found on the [@NAME@ homepage](https://commons.apache.org/proper/commons-@ID@).
The [JavaDoc](https://commons.apache.org/proper/commons-@ID@/javadocs/api-release) can be browsed.
Questions related to the usage of @NAME@ should be posted to the [user mailing list][ml].

Where can I get the latest release?
-----------------------------------
You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-@ID@/download_@[email protected]).

Alternatively you can pull it from the central Maven repositories:

```xml

  @GROUPID@
  @ARTIFACTCOREID@
  @VERSION@

```

Contributing
------------

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.
+ 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.
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn clean test```.

If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).

License
-------
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
---------
You like @NAME@? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.

Additional Resources
--------------------

+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/@JIRA_ID@)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
+ `#apache-commons` IRC channel on `irc.freenode.org`

[ml]:https://commons.apache.org/mail-lists.html