commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From brit...@apache.org
Subject svn commit: r1637657 - /commons/proper/validator/trunk/README.md
Date Sun, 09 Nov 2014 11:35:03 GMT
Author: britter
Date: Sun Nov  9 11:35:02 2014
New Revision: 1637657

URL: http://svn.apache.org/r1637657
Log:
Add README.md for github users

Added:
    commons/proper/validator/trunk/README.md

Added: commons/proper/validator/trunk/README.md
URL: http://svn.apache.org/viewvc/commons/proper/validator/trunk/README.md?rev=1637657&view=auto
==============================================================================
--- commons/proper/validator/trunk/README.md (added)
+++ commons/proper/validator/trunk/README.md Sun Nov  9 11:35:02 2014
@@ -0,0 +1,98 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ 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: mail-lists-template.xml                               |
+ | 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 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.
+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).
+
+Alternatively you can pull it from the central Maven repositories:
+
+```xml
+<dependency>
+  <groupId>commons-validator</groupId>
+  <artifactId>commons-validator</artifactId>
+  <version>1.4.0</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 verify```.
+
+If you plan to contribute on a regular basis, please consider filing a [contributor license
agreement](http://www.apache.org/licenses/#clas).
+
+License
+-------
+Code is under the [Apache Licence v2](http://www.apache.org/licenses/LICENSE-2.0.txt).
+
+Donations
+---------
+You like Apache Commons Validator? Then [donate back to the ASF](http://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 Twitter Account](https://twitter.com/ApacheCommons)
++ #apachecommons IRC channel on freenode.org
+
+[ml]:http://commons.apache.org/proper/commons-validator/mail-lists.html



Mime
View raw message