aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBenedikt Ritter <britter@apache.org>2015-01-02 20:09:51 +0000
committerBenedikt Ritter <britter@apache.org>2015-01-02 20:09:51 +0000
commit9af6c5e07c0513623a0ec8c2f5314c09761f36bc (patch)
tree7dc719a4593e3c25e69fd8cf63408cc3bb31e657 /README.md
parent51607308c7ca4bf736a749b18aa722684a3b6b61 (diff)
downloadapache-commons-lang-9af6c5e07c0513623a0ec8c2f5314c09761f36bc.tar.gz
Use README.md and CONTRIBUTING.md generated by commons build plugin
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/lang/trunk@1649111 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'README.md')
-rw-r--r--README.md72
1 files changed, 61 insertions, 11 deletions
diff --git a/README.md b/README.md
index 74c841251..8d91cba19 100644
--- a/README.md
+++ b/README.md
@@ -14,37 +14,87 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
+<!---
+ +======================================================================+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +======================================================================+
+ | TEMPLATE FILE: readme-md-template.md |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ | |
+ | 1) Re-generate using: mvn commons:readme-md |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.componentid (required, alphabetic, lower case) |
+ | - commons.release.version (required) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.componentid>math</commons.componentid> |
+ | <commons.release.version>1.2</commons.release.version> |
+ | </properties> |
+ | |
+ +======================================================================+
+--->
Apache Commons Lang
===================
-Lang provides a host of helper utilities for the java.lang API, notably String manipulation methods, basic numerical methods, object reflection, concurrency, creation and serialization and System properties. Additionally it contains basic enhancements to java.util.Date and a series of utilities dedicated to help with building methods, such as hashCode, toString and equals.
+Apache Commons Lang, a package of Java utility classes for the
+ classes that are in java.lang's hierarchy, or are considered to be so
+ standard as to justify existence in java.lang.
-More information can be found on the [homepage][home].
+Documentation
+-------------
-The [commons developer mailing list][ml] is the main channel of communication for contributors.
+More information can be found on the [homepage](https://commons.apache.org/proper/commons-lang3).
+The [JavaDoc](https://commons.apache.org/proper/commons-lang3/javadocs/api-release) can be browsed.
+Questions related to the usage of Apache Commons Lang 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][download].
+You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-lang3/download_lang3.cgi).
Alternatively you can pull it from the central Maven repositories:
```xml
+<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.3.2</version>
+</dependency>
```
+Contributing
+------------
+
+We accept PRs 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
-------
-Code is under the [Apache Licence v2][license].
+Code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0.txt).
Donations
---------
-You like Apache Commons Lang? Then [donate back to the ASF][donate] to support the development.
+You like Apache Commons Lang? 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 Bugtracker (JIRA)](https://issues.apache.org/jira/)
++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
++ #apachecommons IRC channel on freenode.org
-[home]:http://commons.apache.org/lang
-[ml]:http://commons.apache.org/lang/mail-lists.html
-[download]:http://commons.apache.org/lang/download_lang.cgi
-[license]:http://www.apache.org/licenses/LICENSE-2.0.txt
-[donate]:http://www.apache.org/foundation/contributing.html
+[ml]:https://commons.apache.org/mail-lists.html