This is an automated email from the ASF dual-hosted git repository.
sebb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-validator.git
The following commit(s) were added to refs/heads/master by this push:
new 360b9e4 Latest versions of documentation
360b9e4 is described below
commit 360b9e42e3ccb493fdae9b22ffa187c1b57a5626
Author: Sebb <s...@apache.org>
AuthorDate: Fri Jul 31 16:11:52 2020 +0100
Latest versions of documentation
---
CONTRIBUTING.md | 44 ++++++++++++++++-------
src/site/xdoc/issue-tracking.xml | 34 +++++++++---------
src/site/xdoc/mail-lists.xml | 77 +++++++++++++++++++++-------------------
3 files changed, 88 insertions(+), 67 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 461f031..c08cad3 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -25,7 +25,7 @@
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:contributing-md |
+ | 1) Re-generate using: mvn commons-build:contributing-md |
| |
| 2) Set the following properties in the component's pom: |
| - commons.jira.id (required, alphabetic, upper case) |
@@ -51,47 +51,65 @@ 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 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 Validator's scope.
-+ Submit a ticket for your issue, assuming one does not already exist.
++ 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.
`VALIDATOR-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. `VALIDATOR-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 Validator JIRA project
page](https://issues.apache.org/jira/browse/VALIDATOR)
++ [Apache Commons Validator 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/VALIDATOR
diff --git a/src/site/xdoc/issue-tracking.xml b/src/site/xdoc/issue-tracking.xml
index fb32592..454f027 100644
--- a/src/site/xdoc/issue-tracking.xml
+++ b/src/site/xdoc/issue-tracking.xml
@@ -26,7 +26,7 @@ limitations under the License.
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:jira-page |
+ | 1) Re-generate using: mvn commons-build:jira-page |
| |
| 2) Set the following properties in the component's pom: |
| - commons.jira.id (required, alphabetic, upper case) |
@@ -43,35 +43,35 @@ limitations under the License.
-->
<document>
<properties>
- <title>Commons Validator Issue tracking</title>
- <author email="d...@commons.apache.org">Commons Documentation Team</author>
+ <title>Apache Commons Validator Issue tracking</title>
+ <author email="d...@commons.apache.org">Apache Commons Documentation
Team</author>
</properties>
<body>
- <section name="Commons Validator Issue tracking">
+ <section name="Apache Commons Validator Issue tracking">
<p>
- Commons Validator uses <a href="http://issues.apache.org/jira/";>ASF
JIRA</a> for tracking issues.
- See the <a href="http://issues.apache.org/jira/browse/VALIDATOR";>Commons
Validator JIRA project page</a>.
+ Apache Commons Validator uses <a
href="https://issues.apache.org/jira/";>ASF JIRA</a> for tracking issues.
+ See the <a href="https://issues.apache.org/jira/browse/VALIDATOR";>Apache
Commons Validator 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 Validator please do the following:
+ Apache Commons Validator please do the following:
<ol>
- <li><a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310494&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>Search
existing open bugs</a>.
+ <li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310494&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&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=12310494&issuetype=1&priority=4&assignee=-1";>bug
report</a>
- or <a
href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310494&issuetype=4&priority=4&assignee=-1";>enhancement
request</a>.</li>
+ <li>Submit either a <a
href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310494&issuetype=1&priority=4&assignee=-1";>bug
report</a>
+ or <a
href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310494&issuetype=4&priority=4&assignee=-1";>enhancement
request</a>.</li>
</ol>
</p>
@@ -80,21 +80,21 @@ 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 Validator are all unpaid volunteers</li>
+ <li>the developers of Apache Commons Validator are all unpaid
volunteers</li>
</ul>
</p>
<p>
For more information on subversion and creating patches see the
- <a href="http://www.apache.org/dev/contributors.html";>Apache
Contributors Guide</a>.
+ <a href="https://www.apache.org/dev/contributors.html";>Apache
Contributors Guide</a>.
</p>
<p>
You may also find these links useful:
<ul>
- <li><a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310494&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>All
Open Commons Validator bugs</a></li>
- <li><a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310494&sorter/field=issuekey&sorter/order=DESC&status=5&status=6";>All
Resolved Commons Validator bugs</a></li>
- <li><a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310494&sorter/field=issuekey&sorter/order=DESC";>All
Commons Validator bugs</a></li>
+ <li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310494&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>All
Open Apache Commons Validator bugs</a></li>
+ <li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310494&sorter/field=issuekey&sorter/order=DESC&status=5&status=6";>All
Resolved Apache Commons Validator bugs</a></li>
+ <li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310494&sorter/field=issuekey&sorter/order=DESC";>All
Apache Commons Validator bugs</a></li>
</ul>
</p>
</section>
diff --git a/src/site/xdoc/mail-lists.xml b/src/site/xdoc/mail-lists.xml
index e0b1075..0654e3c 100644
--- a/src/site/xdoc/mail-lists.xml
+++ b/src/site/xdoc/mail-lists.xml
@@ -26,7 +26,7 @@ limitations under the License.
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:mail-page |
+ | 1) Re-generate using: mvn commons-build:mail-page |
| |
| 2) Set the following properties in the component's pom: |
| - commons.componentid (required, alphabetic, lower case) |
@@ -41,15 +41,15 @@ limitations under the License.
-->
<document>
<properties>
- <title>Commons Validator Mailing Lists</title>
- <author email="d...@commons.apache.org">Commons Documentation Team</author>
+ <title>Apache Commons Validator Mailing Lists</title>
+ <author email="d...@commons.apache.org">Apache Commons Documentation
Team</author>
</properties>
<body>
<section name="Overview">
<p>
- <a href="index.html">Commons Validator</a> shares mailing lists with
all the other
- <a href="http://commons.apache.org/components.html";>Commons
Components</a>.
+ <a href="index.html">Apache Commons Validator</a> shares mailing lists
with all the other
+ <a href="https://commons.apache.org/components.html";>Commons
Components</a>.
To make it easier for people to only read messages related to
components they are interested in,
the convention in Commons is to prefix the subject line of messages
with the component's name,
for example:
@@ -58,24 +58,27 @@ limitations under the License.
</ul>
</p>
<p>
- Questions related to the usage of Commons Validator should be posted
to the
- <a href="http://mail-archives.apache.org/mod_mbox/commons-user/";>User
List</a>.
+ Questions related to the usage of Apache Commons Validator should be
posted to the
+ <a href="https://mail-archives.apache.org/mod_mbox/commons-user/";>User
List</a>.
<br />
- The <a
href="http://mail-archives.apache.org/mod_mbox/commons-dev/";>Developer List</a>
- is for questions and discussion related to the development of Commons
Validator.
+ The <a
href="https://mail-archives.apache.org/mod_mbox/commons-dev/";>Developer List</a>
+ is for questions and discussion related to the development of Apache
Commons Validator.
<br />
Please do not cross-post; developers are also subscribed to the user
list.
+ <br />
+ You must be subscribed to post to the mailing lists. Follow the
Subscribe links below
+ to subscribe.
</p>
<p>
<strong>Note:</strong> please don't send patches or attachments to any
of the mailing lists.
- Patches are best handled via the <a href="issue-tracking.html">Issue
Tracking</a> system.
- Otherwise, please upload the file to a public server and include the
URL in the mail.
+ Patches are best handled via the <a href="issue-tracking.html">Issue
Tracking</a> system.
+ Otherwise, please upload the file to a public server and include the
URL in the mail.
</p>
</section>
- <section name="Commons Validator Mailing Lists">
+ <section name="Apache Commons Validator Mailing Lists">
<p>
- <strong>Please prefix the subject line of any messages for <a
href="index.html">Commons Validator</a>
+ <strong>Please prefix the subject line of any messages for <a
href="index.html">Apache Commons Validator</a>
with <i>[validator]</i></strong> - <i>thanks!</i>
<br />
<br />
@@ -96,16 +99,16 @@ limitations under the License.
<td>
<strong>Commons User List</strong>
<br /><br />
- Questions on using Commons Validator.
+ Questions on using Apache Commons Validator.
<br /><br />
</td>
<td><a
href="mailto:user-subscr...@commons.apache.org";>Subscribe</a></td>
<td><a
href="mailto:user-unsubscr...@commons.apache.org";>Unsubscribe</a></td>
<td><a
href="mailto:u...@commons.apache.org?subject=[validator]";>Post</a></td>
- <td><a
href="http://mail-archives.apache.org/mod_mbox/commons-user/";>mail-archives.apache.org</a></td>
- <td><a
href="http://markmail.org/list/org.apache.commons.users/";>markmail.org</a><br />
- <a
href="http://www.mail-archive.com/user@commons.apache.org/";>www.mail-archive.com</a><br
/>
- <a
href="http://news.gmane.org/gmane.comp.jakarta.commons.devel";>news.gmane.org</a>
+ <td><a
href="https://mail-archives.apache.org/mod_mbox/commons-user/";>mail-archives.apache.org</a></td>
+ <td><a
href="https://markmail.org/list/org.apache.commons.users/";>markmail.org</a><br
/>
+ <a
href="https://www.mail-archive.com/user@commons.apache.org/";>www.mail-archive.com</a><br
/>
+ <a
href="https://news.gmane.org/gmane.comp.jakarta.commons.devel";>news.gmane.org</a>
</td>
</tr>
@@ -114,16 +117,16 @@ limitations under the License.
<td>
<strong>Commons Developer List</strong>
<br /><br />
- Discussion of development of Commons Validator.
+ Discussion of development of Apache Commons Validator.
<br /><br />
</td>
<td><a
href="mailto:dev-subscr...@commons.apache.org";>Subscribe</a></td>
<td><a
href="mailto:dev-unsubscr...@commons.apache.org";>Unsubscribe</a></td>
<td><a
href="mailto:d...@commons.apache.org?subject=[validator]";>Post</a></td>
- <td><a
href="http://mail-archives.apache.org/mod_mbox/commons-dev/";>mail-archives.apache.org</a></td>
- <td><a
href="http://markmail.org/list/org.apache.commons.dev/";>markmail.org</a><br />
- <a
href="http://www.mail-archive.com/dev@commons.apache.org/";>www.mail-archive.com</a><br
/>
- <a
href="http://news.gmane.org/gmane.comp.jakarta.commons.devel";>news.gmane.org</a>
+ <td><a
href="https://mail-archives.apache.org/mod_mbox/commons-dev/";>mail-archives.apache.org</a></td>
+ <td><a
href="https://markmail.org/list/org.apache.commons.dev/";>markmail.org</a><br />
+ <a
href="https://www.mail-archive.com/dev@commons.apache.org/";>www.mail-archive.com</a><br
/>
+ <a
href="https://news.gmane.org/gmane.comp.jakarta.commons.devel";>news.gmane.org</a>
</td>
</tr>
@@ -138,9 +141,9 @@ limitations under the License.
<td><a
href="mailto:issues-subscr...@commons.apache.org";>Subscribe</a></td>
<td><a
href="mailto:issues-unsubscr...@commons.apache.org";>Unsubscribe</a></td>
<td><i>read only</i></td>
- <td><a
href="http://mail-archives.apache.org/mod_mbox/commons-issues/";>mail-archives.apache.org</a></td>
- <td><a
href="http://markmail.org/list/org.apache.commons.issues/";>markmail.org</a><br
/>
- <a
href="http://www.mail-archive.com/issues@commons.apache.org/";>www.mail-archive.com</a>
+ <td><a
href="https://mail-archives.apache.org/mod_mbox/commons-issues/";>mail-archives.apache.org</a></td>
+ <td><a
href="https://markmail.org/list/org.apache.commons.issues/";>markmail.org</a><br
/>
+ <a
href="https://www.mail-archive.com/issues@commons.apache.org/";>www.mail-archive.com</a>
</td>
</tr>
@@ -149,15 +152,15 @@ limitations under the License.
<td>
<strong>Commons Commits List</strong>
<br /><br />
- Only for e-mails automatically generated by the <a
href="source-repository.html">source control</a> sytem.
+ Only for e-mails automatically generated by the <a
href="scm.html">source control</a> sytem.
<br /><br />
</td>
<td><a
href="mailto:commits-subscr...@commons.apache.org";>Subscribe</a></td>
<td><a
href="mailto:commits-unsubscr...@commons.apache.org";>Unsubscribe</a></td>
<td><i>read only</i></td>
- <td><a
href="http://mail-archives.apache.org/mod_mbox/commons-commits/";>mail-archives.apache.org</a></td>
- <td><a
href="http://markmail.org/list/org.apache.commons.commits/";>markmail.org</a><br
/>
- <a
href="http://www.mail-archive.com/commits@commons.apache.org/";>www.mail-archive.com</a>
+ <td><a
href="https://mail-archives.apache.org/mod_mbox/commons-commits/";>mail-archives.apache.org</a></td>
+ <td><a
href="https://markmail.org/list/org.apache.commons.commits/";>markmail.org</a><br
/>
+ <a
href="https://www.mail-archive.com/commits@commons.apache.org/";>www.mail-archive.com</a>
</td>
</tr>
@@ -185,14 +188,14 @@ limitations under the License.
General announcements of Apache project releases.
<br /><br />
</td>
- <td><a class="externalLink"
href="mailto:announce-subscr...@apache.org";>Subscribe</a></td>
- <td><a class="externalLink"
href="mailto:announce-unsubscr...@apache.org";>Unsubscribe</a></td>
+ <td><a class="externalLink"
href="mailto:announce-subscr...@apache.org";>Subscribe</a></td>
+ <td><a class="externalLink"
href="mailto:announce-unsubscr...@apache.org";>Unsubscribe</a></td>
<td><i>read only</i></td>
- <td><a class="externalLink"
href="http://mail-archives.apache.org/mod_mbox/www-announce/";>mail-archives.apache.org</a></td>
- <td><a class="externalLink"
href="http://markmail.org/list/org.apache.announce/";>markmail.org</a><br />
- <a class="externalLink"
href="http://old.nabble.com/Apache-News-and-Announce-f109.html";>old.nabble.com</a><br
/>
- <a class="externalLink"
href="http://www.mail-archive.com/announce@apache.org/";>www.mail-archive.com</a><br
/>
- <a class="externalLink"
href="http://news.gmane.org/gmane.comp.apache.announce";>news.gmane.org</a>
+ <td><a class="externalLink"
href="https://mail-archives.apache.org/mod_mbox/www-announce/";>mail-archives.apache.org</a></td>
+ <td><a class="externalLink"
href="https://markmail.org/list/org.apache.announce/";>markmail.org</a><br />
+ <a class="externalLink"
href="https://old.nabble.com/Apache-News-and-Announce-f109.html";>old.nabble.com</a><br
/>
+ <a class="externalLink"
href="https://www.mail-archive.com/announce@apache.org/";>www.mail-archive.com</a><br
/>
+ <a class="externalLink"
href="https://news.gmane.org/gmane.comp.apache.announce";>news.gmane.org</a>
</td>
</tr>
</table>
