commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bode...@apache.org
Subject svn commit: r1803365 - in /commons/proper/email/trunk: CONTRIBUTING.md src/site/xdoc/issue-tracking.xml src/site/xdoc/mail-lists.xml
Date Sat, 29 Jul 2017 13:45:55 GMT
Author: bodewig
Date: Sat Jul 29 13:45:55 2017
New Revision: 1803365

URL: http://svn.apache.org/viewvc?rev=1803365&view=rev
Log:
update a few other pages to latest commons-build versions

Added:
    commons/proper/email/trunk/CONTRIBUTING.md
Modified:
    commons/proper/email/trunk/src/site/xdoc/issue-tracking.xml
    commons/proper/email/trunk/src/site/xdoc/mail-lists.xml

Added: commons/proper/email/trunk/CONTRIBUTING.md
URL: http://svn.apache.org/viewvc/commons/proper/email/trunk/CONTRIBUTING.md?rev=1803365&view=auto
==============================================================================
--- commons/proper/email/trunk/CONTRIBUTING.md (added)
+++ commons/proper/email/trunk/CONTRIBUTING.md Sat Jul 29 13:45:55 2017
@@ -0,0 +1,97 @@
+<!---
+ 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: contributing-md-template.md                           |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ |                                                                      |
+ | 1) Re-generate using: mvn commons:contributing-md                    |
+ |                                                                      |
+ | 2) Set the following properties in the component's pom:              |
+ |    - commons.jira.id  (required, alphabetic, upper case)             |
+ |                                                                      |
+ | 3) Example Properties                                                |
+ |                                                                      |
+ |  <properties>                                                        |
+ |    <commons.jira.id>MATH</commons.jira.id>                           |
+ |  </properties>                                                       |
+ |                                                                      |
+ +======================================================================+
+--->
+Contributing to Apache Commons Email
+======================
+
+You have found a bug or you have an idea for a cool new feature? Contributing code is a great
way to give something back to
+the open source community. Before you dig right into the code there are a few guidelines
that we need contributors to
+follow so that we can have a chance of keeping on top of things.
+
+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 you're 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
Email's scope.
++ Submit a ticket 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.
+
+Making Changes
+--------------
+
++ Create a topic branch from where you want to base your work (this is usually the master/trunk
branch).
++ Make commits of logical units.
++ 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.
++ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.
+
+Making Trivial Changes
+----------------------
+
+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.
++ Push your changes to a topic branch in your fork of the repository.
++ Submit a pull request to the repository in the apache organization.
++ Update your JIRA ticket and include a link to the pull request in the ticket.
+
+Additional Resources
+--------------------
+
++ [Contributing patches](https://commons.apache.org/patches.html)
++ [Apache Commons Email JIRA project page](https://issues.apache.org/jira/browse/EMAIL)
++ [Contributor License Agreement][cla]
++ [General GitHub documentation](https://help.github.com/)
++ [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
++ #apachecommons IRC channel on freenode.org
+
+[cla]:https://www.apache.org/licenses/#clas

Modified: commons/proper/email/trunk/src/site/xdoc/issue-tracking.xml
URL: http://svn.apache.org/viewvc/commons/proper/email/trunk/src/site/xdoc/issue-tracking.xml?rev=1803365&r1=1803364&r2=1803365&view=diff
==============================================================================
--- commons/proper/email/trunk/src/site/xdoc/issue-tracking.xml (original)
+++ commons/proper/email/trunk/src/site/xdoc/issue-tracking.xml Sat Jul 29 13:45:55 2017
@@ -43,35 +43,35 @@ limitations under the License.
 -->
 <document>
   <properties>
-    <title>Commons Email Issue tracking</title>
-    <author email="dev@commons.apache.org">Commons Documentation Team</author>
+    <title>Apache Commons Email Issue tracking</title>
+    <author email="dev@commons.apache.org">Apache Commons Documentation Team</author>
   </properties>
   <body>
 
-    <section name="Commons Email Issue tracking">
+    <section name="Apache Commons Email Issue tracking">
       <p>
-      Commons Email uses <a href="http://issues.apache.org/jira/">ASF JIRA</a>
for tracking issues.
-      See the <a href="http://issues.apache.org/jira/browse/EMAIL">Commons Email JIRA
project page</a>.
+      Apache Commons Email uses <a href="https://issues.apache.org/jira/">ASF JIRA</a>
for tracking issues.
+      See the <a href="https://issues.apache.org/jira/browse/EMAIL">Apache Commons
Email 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 Email please do the following:
+      Apache Commons Email please do the following:
       <ol>
-        <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310474&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=1&amp;status=3&amp;status=4">Search
existing open bugs</a>.
+        <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310474&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=1&amp;status=3&amp;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=12310474&amp;issuetype=1&amp;priority=4&amp;assignee=-1">bug
report</a>
-            or <a href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310474&amp;issuetype=4&amp;priority=4&amp;assignee=-1">enhancement
request</a>.</li>
+        <li>Submit either a <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310474&amp;issuetype=1&amp;priority=4&amp;assignee=-1">bug
report</a>
+            or <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310474&amp;issuetype=4&amp;priority=4&amp;assignee=-1">enhancement
request</a>.</li>
       </ol>
       </p>
 
@@ -80,7 +80,7 @@ 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 Email are all unpaid volunteers</li>
+        <li>the developers of Apache Commons Email are all unpaid volunteers</li>
       </ul>
       </p>
 
@@ -92,9 +92,9 @@ limitations under the License.
       <p>
       You may also find these links useful:
       <ul>
-        <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310474&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=1&amp;status=3&amp;status=4">All
Open Commons Email bugs</a></li>
-        <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310474&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=5&amp;status=6">All
Resolved Commons Email bugs</a></li>
-        <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310474&amp;sorter/field=issuekey&amp;sorter/order=DESC">All
Commons Email bugs</a></li>
+        <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310474&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=1&amp;status=3&amp;status=4">All
Open Apache Commons Email bugs</a></li>
+        <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310474&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=5&amp;status=6">All
Resolved Apache Commons Email bugs</a></li>
+        <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310474&amp;sorter/field=issuekey&amp;sorter/order=DESC">All
Apache Commons Email bugs</a></li>
       </ul>
       </p>
     </section>

Modified: commons/proper/email/trunk/src/site/xdoc/mail-lists.xml
URL: http://svn.apache.org/viewvc/commons/proper/email/trunk/src/site/xdoc/mail-lists.xml?rev=1803365&r1=1803364&r2=1803365&view=diff
==============================================================================
--- commons/proper/email/trunk/src/site/xdoc/mail-lists.xml (original)
+++ commons/proper/email/trunk/src/site/xdoc/mail-lists.xml Sat Jul 29 13:45:55 2017
@@ -41,14 +41,14 @@ limitations under the License.
 -->
 <document>
   <properties>
-    <title>Commons Email Mailing Lists</title>
-    <author email="dev@commons.apache.org">Commons Documentation Team</author>
+    <title>Apache Commons Email Mailing Lists</title>
+    <author email="dev@commons.apache.org">Apache Commons Documentation Team</author>
   </properties>
   <body>
 
     <section name="Overview">
       <p>
-        <a href="index.html">Commons Email</a> shares mailing lists with all
the other 
+        <a href="index.html">Apache Commons Email</a> shares mailing lists with
all the other
         <a href="http://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,
@@ -58,24 +58,27 @@ limitations under the License.
         </ul>
       </p>
       <p>
-        Questions related to the usage of Commons Email should be posted to the
+        Questions related to the usage of Apache Commons Email should be posted to the
         <a href="http://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 Email.
+        is for questions and discussion related to the development of Apache Commons Email.
         <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 Email Mailing Lists">
+    <section name="Apache Commons Email Mailing Lists">
       <p>
-        <strong>Please prefix the subject line of any messages for <a href="index.html">Commons
Email</a>
+        <strong>Please prefix the subject line of any messages for <a href="index.html">Apache
Commons Email</a>
         with <i>[email]</i></strong> - <i>thanks!</i>
         <br />
         <br />
@@ -96,7 +99,7 @@ limitations under the License.
           <td>
             <strong>Commons User List</strong>
             <br /><br />
-            Questions on using Commons Email.
+            Questions on using Apache Commons Email.
             <br /><br />
           </td>
           <td><a href="mailto:user-subscribe@commons.apache.org">Subscribe</a></td>
@@ -114,7 +117,7 @@ limitations under the License.
           <td>
             <strong>Commons Developer List</strong>
             <br /><br />
-            Discussion of development of Commons Email.
+            Discussion of development of Apache Commons Email.
             <br /><br />
           </td>
           <td><a href="mailto:dev-subscribe@commons.apache.org">Subscribe</a></td>
@@ -185,10 +188,10 @@ limitations under the License.
             General announcements of Apache project releases.
             <br /><br />
           </td>
-          <td><a class="externalLink" href="mailto:announce-subscribe@apache.org">Subscribe</a></td>

-          <td><a class="externalLink" href="mailto:announce-unsubscribe@apache.org">Unsubscribe</a></td>

+          <td><a class="externalLink" href="mailto:announce-subscribe@apache.org">Subscribe</a></td>
+          <td><a class="externalLink" href="mailto:announce-unsubscribe@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://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
/>



Mime
View raw message