You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by pa...@apache.org on 2017/08/04 16:05:40 UTC
svn commit: r1804140 - /commons/proper/validator/trunk/README.md
Author: pascalschumacher
Date: Fri Aug 4 16:05:40 2017
New Revision: 1804140
URL: http://svn.apache.org/viewvc?rev=1804140&view=rev
Log:
update README.md
Modified:
commons/proper/validator/trunk/README.md
Modified: commons/proper/validator/trunk/README.md
URL: http://svn.apache.org/viewvc/commons/proper/validator/trunk/README.md?rev=1804140&r1=1804139&r2=1804140&view=diff
==============================================================================
--- commons/proper/validator/trunk/README.md (original)
+++ commons/proper/validator/trunk/README.md Fri Aug 4 16:05:40 2017
@@ -43,19 +43,22 @@
Apache Commons Validator
===================
+[![Build Status](https://travis-ci.org/apache/commons-validator.svg?branch=trunk)](https://travis-ci.org/apache/commons-validator)
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/commons-validator/commons-validator/badge.svg)](https://maven-badges.herokuapp.com/maven-central/commons-validator/commons-validator/)
+
Apache Commons Validator provides the building blocks for both client side validation and server side data validation.
It may be used standalone or with a framework like Struts.
Documentation
-------------
-More information can be found on the [homepage](http://commons.apache.org/proper/commons-validator).
-The [JavaDoc](http://commons.apache.org/proper/commons-validator/javadocs/api-release) can be browsed.
+More information can be found on the [Apache Commons Validator homepage](https://commons.apache.org/proper/commons-validator).
+The [JavaDoc](https://commons.apache.org/proper/commons-validator/javadocs/api-release) can be browsed.
Questions related to the usage of Apache Commons Validator 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](http://commons.apache.org/proper/commons-validator/download_validator.cgi).
+You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-validator/download_validator.cgi).
Alternatively you can pull it from the central Maven repositories:
@@ -70,30 +73,32 @@ Alternatively you can pull it from the c
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.
+ 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](http://www.apache.org/licenses/#clas).
-You can learn more about contributing via GitHub in our [contribution guidelines](https://github.com/apache/commons-validator/blob/trunk/CONTRIBUTING.md).
+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](http://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
---------
-You like Apache Commons Validator? Then [donate back to the ASF](http://www.apache.org/foundation/contributing.html) to support the development.
+You like Apache Commons Validator? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
Additional Resources
--------------------
-+ [Apache Commons Homepage](http://commons.apache.org/)
-+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
++ [Apache Commons Homepage](https://commons.apache.org/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/VALIDATOR)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ #apachecommons IRC channel on freenode.org
++ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:http://commons.apache.org/proper/commons-validator/mail-lists.html
+[ml]:https://commons.apache.org/mail-lists.html