commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From er...@apache.org
Subject [19/31] commons-numbers git commit: Correct project info.
Date Fri, 20 Jan 2017 14:46:06 GMT
Correct project info.


Project: http://git-wip-us.apache.org/repos/asf/commons-numbers/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-numbers/commit/81911e4c
Tree: http://git-wip-us.apache.org/repos/asf/commons-numbers/tree/81911e4c
Diff: http://git-wip-us.apache.org/repos/asf/commons-numbers/diff/81911e4c

Branch: refs/heads/master
Commit: 81911e4c754d7636ff2acb91e93b5fffc2f9e7c6
Parents: 7a4a3a6
Author: Gilles Sadowski <gilles@harfang.homelinux.org>
Authored: Fri Jan 20 13:39:29 2017 +0100
Committer: Gilles Sadowski <gilles@harfang.homelinux.org>
Committed: Fri Jan 20 13:39:29 2017 +0100

----------------------------------------------------------------------
 src/site/xdoc/developers.xml       | 593 +++++++++++++-------------------
 src/site/xdoc/download_numbers.xml | 154 +++++++++
 src/site/xdoc/issue-tracking.xml   |  30 +-
 src/site/xdoc/mail-lists.xml       |  39 ++-
 4 files changed, 436 insertions(+), 380 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/81911e4c/src/site/xdoc/developers.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/developers.xml b/src/site/xdoc/developers.xml
index f280a6c..d62066b 100644
--- a/src/site/xdoc/developers.xml
+++ b/src/site/xdoc/developers.xml
@@ -17,352 +17,251 @@
   -->
   
 <document>
- <properties>
-  <title>Developers Guide</title>
- </properties>
+  <properties>
+    <title>Developers Guide</title>
+  </properties>
+  
+  <body>
+
+    <section name="Aims">
+      <p>
+        Maintenance of a library by decentralized team requires communication.
+        It is important that developers follow guidelines laid down by the community
+        to ensure that the code they create can be successfully maintained by others.
+      </p>
+    </section>
+    
+    <section name='Guidelines'>
+      <p>
+        Developers are asked to comply with the following development guidelines.
+        Code that does not comply with the guidelines including the word <i>must</i>
+        will not be committed.  Our aim will be to fix all of the exceptions to the
+        "<i>should</i>" guidelines prior to a release.
+      </p>
+      <subsection name="Contributing">
+        <p><strong>Getting Started</strong></p>
+        <p>
+          <ol>
+            <li>
+              Download the Commons Numbers source code.  Follow the instructions
+              under the heading "Repository Checkout" on the
+              <a href="https://git-wip-us.apache.org/">Git at the ASF page</a>.
+              The git url for the current development sources of Commons Numbers
+              is <source>http://git-wip-us.apache.org/repos/asf/commons-numbers.git</source>
+              for anonymous read-only access and
+              <source>https://apacheid@git-wip-us.apache.org/repos/asf/commons-numbers.git</source>
+              (where apacheid should be replaced by each committer Apache ID) for committers
+              read-write access.
+            </li>
+            <li>
+              Like most commons components, Commons Numbers uses Apache Maven as our
+              build tool. The sources can also be built using Ant (a working 
+              Ant build.xml is included in the top level project directory). 
+              To build Commons Numbers using Maven, you can follow the instructions for
+              <a href="http://maven.apache.org/run-maven/index.html">Building a
+              project with Maven</a>.
+              Launch Maven from the top-level directory
+              in the checkout of Commons Numbers trunk. No special setup is required,
+              except that currently to build the site (i.e. to execute Maven's
+              "site" goal), you may need to increase the default memory allocation
+              (e.g. <code>export MAVEN_OPTS=-Xmx512m</code>) before launching
+              Maven.
+            </li>
+            <li>
+              Be sure to join the commons-dev and commons-user 
+              <a href="mail-lists.html">
+                email lists</a> and use them appropriately (make sure the string
+                "[Numbers]" starts the Subject line of all your postings).
+                Make any proposals here where the group can comment on them.
+            </li>
+            <li>
+              <a href="https://issues.apache.org/jira/secure/Signup!default.jspa">
+                Setup an account on JIRA
+              </a>
+              and use it to submit patches and
+              identify bugs. Read the 
+              <a href="http://issues.apache.org/bugwritinghelp.html">
+              directions</a>
+              for submitting bugs and search the database to
+              determine if an issue exists or has already been dealt with.        
+              <p>
+                See the <a href="http://commons.apache.org/numbers/issue-tracking.html">
+                Commons Numbers Issue Tracking Page</a>
+                for more information on how to
+                search for or submit bugs or enhancement requests.
+              </p>
+              <li>
+                Generating patches: The requested format for generating patches is
+                the Unified Diff format, which can be easily generated using the git
+                client or various IDEs.
+                <source>git diff -p > patch </source>
+                Run this command from the top-level project directory (where pom.xml
+                resides).
+              </li>
+            </li>
+          </ol>
+        </p>
+        <p><strong>Contributing ideas and code</strong></p>
+        <p>
+          Follow the steps below when making suggestions for additions or
+          enhancements to Commons Numbers. This will make it easier for the community
+          to comment on your ideas and for the committers to keep track of them. 
+          Thanks in advance!
+          <ol>
+            <li>Start with a post to the commons-dev mailing list, with [Numbers] at
+            the beginning of the subject line, followed by a short title
+            describing the new feature or enhancement;  for example, "[Numbers]
+            New cryptographically secure generator".
+            The body of the post should include each of the following items
+            (but be <strong>as brief as possible</strong>):
+            <ul>
+              <li>A concise description of the new feature / enhancement</li>
+              <li>References to definitions and algorithms. Using standard
+              definitions and algorithms makes communication much easier and will
+              greatly increase the chances that we will accept the code / idea</li>
+              <li>Some indication of why the addition / enhancement is practically
+              useful</li>
+            </ul></li>
+            <li>Create a JIRA ticket using the the feature title as the short
+            description. Incorporate feedback from the initial posting in the
+            description. Add a reference to the JIRA ticket to the WishList entry.
+            </li>
+            <li>Submit code as attachments to the JIRA ticket.  Please use one
+            ticket for each feature, adding multiple patches to the ticket
+            as necessary.  Use the git diff command to generate your patches as
+            diffs.  Please do not submit modified copies of existing java files. Be
+            patient (but not <strong>too</strong> patient) with  committers reviewing
+            patches. Post a *nudge* message to commons-dev with a reference to the
+            ticket if a patch goes more than a few days with no comment or commit.
+            </li>
+          </ol>
+        </p>   
+      </subsection>
 
- <body>
-  <section name="Aims">
-   <p>
-    Creating and maintaining a mathematical and statistical library that is
-    accurate requires a greater degree of communication than might be the
-    case for other components. It is important that developers follow
-    guidelines laid down by the community to ensure that the code they create
-    can be successfully maintained by others.
-    </p>
-   </section>
-   <section name='Guidelines'>
-   <p>
-   Developers are asked to comply with the following development guidelines.
-   Code that does not comply with the guidelines including the word <i>must</i>
-   will not be committed.  Our aim will be to fix all of the exceptions to the
-   "<i>should</i>" guidelines prior to a release.
-   </p>
-   <subsection name="Contributing">
-    <p><strong>Getting Started</strong></p>
-    <p>
-    <ol>
-        <li>Start by reviewing the overall objectives stated in the
-            <a href="proposal.html">proposal</a> upon which the project is 
-            founded.
-        </li>
-        <li>Download the Commons Math source code.  Follow the instructions
-        under the heading "Repository Checkout" on the
-        <a href="https://git-wip-us.apache.org/">Git at the ASF page</a>.
-        The git url for the current development sources of Commons Math
-        is <source>http://git-wip-us.apache.org/repos/asf/commons-math.git</source>
-        for anonymous read-only access and
-        <source>https://apacheid@git-wip-us.apache.org/repos/asf/commons-math.git</source>
-        (where apacheid should be replaced by each committer Apache ID) for committers
-        read-write access.
-        </li>
-        <li>Like most commons components, Commons Math uses Apache Maven as our
-            build tool. The sources can also be built using Ant (a working 
-            Ant build.xml is included in the top level project directory). 
-            To build Commons Math using Maven, you can follow the instructions for
-            <a href="http://maven.apache.org/run-maven/index.html">Building a
-            project with Maven</a>. Launch Maven from the top-level directory
-            in the checkout of Commons Math trunk. No special setup is required,
-            except that currently to build the site (i.e. to execute Maven's
-            "site" goal), you may need to increase the default memory allocation
-            (e.g. <code>export MAVEN_OPTS=-Xmx512m</code>) before launching
-            Maven.
-        </li>
-        <li>Have a look at the new features that users and developers have requested
-            on the <a href="http://wiki.apache.org/commons/MathWishList">
-            Math Wish List Wiki Page.</a>
-        </li>
-        <li>Be sure to join the commons-dev and commons-user 
-            <a href="mail-lists.html">
-            email lists</a> and use them appropriately (make sure the string
-            "[math]" starts the Subject line of all your postings).
-            Make any proposals here where the group can comment on them.
-        </li>
-        <li>
-            <a href="https://issues.apache.org/jira/secure/Signup!default.jspa">
-            Setup an account on JIRA</a> and use it to submit patches and
-            identify bugs. Read the 
-            <a href="http://issues.apache.org/bugwritinghelp.html">
-            directions</a> for submitting bugs and search the database to
-            determine if an issue exists or has already been dealt with.        
-            <p>
-              See the <a href="http://commons.apache.org/math/issue-tracking.html">
-              Commons Math Issue Tracking Page</a> for more information on how to
-              search for or submit bugs or enhancement requests.
-            </p>     
-        <li>
-          Generating patches: The requested format for generating patches is
-          the Unified Diff format, which can be easily generated using the git
-          client or various IDEs.
-<source>git diff -p > patch </source>
-          Run this command from the top-level project directory (where pom.xml
-          resides).
-        </li>
-      </li>
-    </ol>
-    </p>
-    <p><strong>Contributing ideas and code</strong></p>
-    <p>
-     Follow the steps below when making suggestions for additions or
-     enhancements to Commons Math. This will make it easier for the community
-     to comment on your ideas and for the committers to keep track of them. 
-     Thanks in advance!
-     <ol>
-       <li>Start with a post to the commons-dev mailing list, with [math] at
-       the beginning of the subject line, followed by a good, short title
-       describing the new feature or enhancement.  For example, "[math]
-       Principal Components Analysis." The body of the post should include each
-       of the following items (but be <strong>as brief as possible</strong>):
-       <ul>
-         <li>A concise description of the new feature / enhancement</li>
-         <li>References to definitions and algorithms. Using standard
-         definitions and algorithms makes communication much easier and will
-         greatly increase the chances that we will accept the code / idea</li>
-         <li>Some indication of why the addition / enhancement is practically
-         useful</li>
-       </ul></li>
-       <li>Assuming a generally favorable response to the idea on commons-dev,
-       the next step is to add an entry to the 
-       <a href="http://wiki.apache.org/commons/MathWishList">Math Wish
-       List</a> corresponding to the idea.  Include a reference to the
-       discussion thread. </li>
-       <li>Create a JIRA ticket using the the feature title as the short
-       description. Incorporate feedback from the initial posting in the
-       description. Add a reference to the JIRA ticket to the WishList entry.
-       </li>
-       <li>Submit code as attachments to the JIRA ticket.  Please use one
-       ticket for each feature, adding multiple patches to the ticket
-       as necessary.  Use the git diff command to generate your patches as
-       diffs.  Please do not submit modified copies of existing java files. Be
-       patient (but not <strong>too</strong> patient) with  committers reviewing
-       patches. Post a *nudge* message to commons-dev with a reference to the
-       ticket if a patch goes more than a few days with no comment or commit.
-       </li>
-      </ol>
-    </p>   
-   </subsection>
-   <subsection name='Coding Style'>
-    <p>
-     Commons Math follows <a href="http://java.sun.com/docs/codeconv/">Code
-     Conventions for the Java Programming Language</a>. As part of the maven
-     build process, style checking is performed using the Checkstyle plugin,
-     using the properties specified in <code>checkstyle.xml</code>.
-     Committed code <i>should</i> generate no Checkstyle errors.  One thing
-     that Checkstyle will complain about is tabs included in the source code.
-     Please make sure to set your IDE or editor to use spaces instead of tabs.
-    </p>
-    <p>
-     Committers should configure the <source>user.name</source>,
-     <source>user.email</source> and <source>core.autocrlf</source>
-     git repository or global settings with <source>git config</source>.
-     The first two settings define the identity and mail of the committer.
-     The third setting deals with line endings to achieve consistency
-     in line endings. Windows users should configure this setting to
-     <source>true</source> (thus forcing git to convert CR/LF line endings
-     in the workspace while maintaining LF only line endings in the repository)
-     while OS X and Linux users should configure it to <source>input</source>
-     (thus forcing git to only strip accidental CR/LF when committing into
-     the repository, but never when cheking out files from the repository). See <a
-     href="http://www.git-scm.com/book/en/Customizing-Git-Git-Configuration">Customizing
-     Git - Git Configuration</a> in the git book for explanation about how to
-     configure these settings and more.
-    </p>
-   </subsection>
-   <subsection name='Documentation'>
-    <ul>
-     <li>
-      Committed code <i>must</i> include full javadoc.</li>
-     <li>
-      All component contracts <i>must</i> be fully specified in the javadoc class,
-      interface or method comments, including specification of acceptable ranges
-      of values, exceptions or special return values.</li>
-     <li>
-      External references or full statements of definitions for all mathematical
-      terms used in component documentation <i>must</i> be provided.</li>
-     <li>
-      Commons math javadoc generation now supports embedded LaTeX formulas via the
-      <a href="http://www.mathjax.org">MathJax</a> javascript display engine. To
-      embed mathematical expressions formatted in LaTeX in javadoc, simply surround
-      the expression to be formatted with either &#92;( and &#92;) for inline
-      formulas, or &#92;[ and &#92;] to have the formula appear on a separate line.
-      For example, &#92;(a^2 + b^2 = c^2&#92;) will render an in-line formula
-      saying that (a, b, c) is Pythagorean triplet.  Using &#92;[ and &#92;] on
-      the ends will render the same formula on a separate line.  See the MathJax
-      and LaTex documentation for details on how to represent formulas and
-      escape special characters.</li>
-     <li>
-      Implementations <i>should</i> use standard algorithms and
-      references or full descriptions of all algorithms <i>should</i> be 
-      provided.</li>
-     <li>
-      Additions and enhancements <i>should</i> include updates to the User
-      Guide.</li>
-    </ul>
-   </subsection>
-   <subsection name='Exceptions'>
-    <ul>
-      <li>
-      Exceptions generated by Commons Math are all unchecked.</li>
-      <li>
-      All public methods advertise all exceptions that they can generate.
-      Exceptions <i>must</i> be documented in both javadoc and method signatures
-      and the documentation in the javadoc <i>must</i> include full description
-      of the conditions under which exceptions are thrown.</li>
-      <li>
-      Methods <i>should</i> fully specify parameter preconditions required for
-      successful activation.  When preconditions are violated, a
-      MathIllegalArgumentException should be thrown.  Subclasses of
-      MathIllegalArgumentException may be used to represent common parameter
-      contract violations (for example, NoBracketingException).  Exception
-      messages <i>must</i> contain sufficient information on parameter values to
-      determine the exact precondition failure.</li>
-      <li>
-      Exceptions generated by Commons Math make sense without knowing
-      implementation details other than those stated in the public API.
-      For example, a NoBracketingException makes sense thrown by a solver that
-      has a precondition requiring that initial points bracket a root. This
-      exception does not make sense, however, thrown by an inverse cumulative
-      probability estimator.</li>
-      <li>
-      MathIllegalArgumentException should only be thrown in situations
-      where preconditions can be exhaustively provided so that what arguments
-      are "illegal" can be specified fully to the caller. Domain-specific
-      exceptions need to be defined for cases where failures cannot be
-      attributed to parameter precondition violation. For example, the exact
-      domain of successful activation of a solver or quadrature method may be
-      impossible to specify because of numerical properties of the method.
-      If a solver fails to find a root or a quadrature method fails to converge
-      for a given set of parameters, <i>unless those parameters violate the
-      advertised preconditions</i> it is not appropriate to throw 
-      MathIllegalArgumentException.</li>
-      <li>
-      State information included in exception messages <i>must</i> be available
-      in exception properties - i.e., successful handling or reporting of 
-      Commons Math exceptions must not require parsing exception messages.</li>
-     </ul>
-   </subsection>
-   <subsection name='Unit Tests'>
-    <ul>
-     <li>
-      Committed code <i>must</i> include unit tests.</li>
-     <li>
-      Unit tests <i>should</i> provide full path coverage. </li>
-     <li>
-      Unit tests <i>should</i> verify all boundary conditions specified in
-      interface contracts, including verification that exceptions are thrown or
-      special values (e.g. Double.NaN, Double.Infinity) are returned as
-      expected. </li>
-    </ul>
-   </subsection>
-   <subsection name='Licensing and copyright'>
-    <ul>
-     <li>
-      All new source file submissions <i>must</i> include the Apache Software
-      License in a comment that begins the file </li>
-     <li>
-      All contributions must comply with the terms of the Apache 
-      <a href="http://www.apache.org/licenses/cla.pdf">Contributor License
-      Agreement (CLA)</a></li>
-     <li>
-       Patches <i>must</i> be accompanied by a clear reference to a "source"
-       - if code has been "ported" from another language, clearly state the
-       source of the original implementation.  If the "expression" of a given
-       algorithm is derivative, please note the original source (textbook,
-       paper, etc.).</li>
-     <li>
-       References to source materials covered by restrictive proprietary
-       licenses should be avoided.  In particular, contributions should not
-       implement or include references to algorithms in 
-       <a href="http://www.nr.com/">Numerical Recipes (NR)</a>.
-       Any questions about copyright or patent issues should be raised on
-       the commons-dev mailing list before contributing or committing code.
-      </li>
-    </ul>
-   </subsection>
-  </section>
-  <section name='Recommended Readings'>
-   <p>
-    Here is a list of relevant materials.  Much of the discussion surrounding
-    the development of this component will refer to the various sources
-    listed below, and frequently the Javadoc for a particular class or
-    interface will link to a definition contained in these documents.
-   </p>
-   <subsection name='Recommended Readings'>
-    <dl>
-     <dt>Concerning floating point arithmetic.</dt>
-     <dd>
-      <a href="http://www.validlab.com/goldberg/paper.pdf">
-       http://www.validlab.com/goldberg/paper.pdf
-      </a><br/>
-      <a href="http://www.cs.berkeley.edu/~wkahan/ieee754status/IEEE754.PDF">
-       http://www.cs.berkeley.edu/~wkahan/ieee754status/IEEE754.PDF
-      </a><br/>
-      <a href="http://www.cs.berkeley.edu/~wkahan/JAVAhurt.pdf">
-       http://www.cs.berkeley.edu/~wkahan/JAVAhurt.pdf
-      </a><br/>
-     </dd>
-     <dt>Numerical analysis</dt>
-     <dd>
-      <a href="http://www.mathcom.com/corpdir/techinfo.mdir/scifaq/index.html">
-        Scientific Computing FAQ @ Mathcom
-      </a><br/>
-      <a href="http://www.ma.man.ac.uk/~higham/asna/asna2.pdf">
-       Bibliography of accuracy and stability of numerical algorithms
-      </a><br/>
-       <a href="http://tonic.physics.sunysb.edu/docs/num_meth.html">
-       SUNY Stony Brook numerical methods page
-      </a><br/>
-       <a href="http://epubs.siam.org/sam-bin/dbq/toclist/SINUM">
-       SIAM Journal of Numerical Analysis Online
-      </a><br/>
-     </dd>
-     <dt>Probability and statistics</dt>
-     <dd>
-      <a href="http://lib.stat.cmu.edu/">
-       Statlib at CMU
-      </a><br/>
-      <a href="http://www.itl.nist.gov/div898/handbook/">
-       NIST Engineering Statistics Handbook
-      </a><br/>
-      <a href="http://www.psychstat.smsu.edu/sbk00.htm">
-       Online Introductory Statistics (David W. Stockburger)
-      </a><br/>
-       <a href="http://www.jstatsoft.org/">
-       Online Journal of Statistical Software
-      </a><br/>
-     </dd>
-    </dl>
-   </subsection>
-   <subsection name='Javadoc comment resources'>
-    <dl>
-     <dt>References for mathematical definitions.</dt>
-     <dd>
-      <a href="http://rd11.web.cern.ch/RD11/rkb/titleA.html">
-       http://rd11.web.cern.ch/RD11/rkb/titleA.html
-      </a><br/>
-      <a href="http://mathworld.wolfram.com/">
-       http://mathworld.wolfram.com/
-      </a><br/>
-      <a href="http://www.itl.nist.gov/div898/handbook">
-       http://www.itl.nist.gov/div898/handbook
-      </a><br/>
-      <a href="http://doi.acm.org/10.1145/359146.359152">
-       Chan, T. F. and J. G. Lewis 1979, <i>Communications of the ACM</i>,
-       vol. 22 no. 9, pp. 526-531.
-      </a><br/>
-     </dd>
-    </dl>
-   </subsection>
-   <subsection name='XML'>
-    <dl>
-     <dt>XML related resources.</dt>
-     <dd>
-      <a href="http://www.openmath.org">
-       http://www.openmath.org
-      </a><br/>
-     </dd>
-    </dl>
-   </subsection>
-  </section>
- </body>
+      <subsection name='Coding Style'>
+        <p>
+          Commons Numbers follows <a href="http://java.sun.com/docs/codeconv/">Code
+          Conventions for the Java Programming Language</a>. As part of the maven
+          build process, style checking is performed using the Checkstyle plugin,
+          using the properties specified in <code>checkstyle.xml</code>.
+          Committed code <i>should</i> generate no Checkstyle errors.  One thing
+          that Checkstyle will complain about is tabs included in the source code.
+          Please make sure to set your IDE or editor to use spaces instead of tabs.
+        </p>
+        <p>
+          Committers should configure the <source>user.name</source>,
+          <source>user.email</source> and <source>core.autocrlf</source>
+          git repository or global settings with <source>git config</source>.
+          The first two settings define the identity and mail of the committer.
+          The third setting deals with line endings to achieve consistency
+          in line endings. Windows users should configure this setting to
+          <source>true</source> (thus forcing git to convert CR/LF line endings
+          in the workspace while maintaining LF only line endings in the repository)
+          while OS X and Linux users should configure it to <source>input</source>
+          (thus forcing git to only strip accidental CR/LF when committing into
+          the repository, but never when cheking out files from the repository). See <a
+          href="http://www.git-scm.com/book/en/Customizing-Git-Git-Configuration">Customizing
+          Git - Git Configuration</a> in the git book for explanation about how to
+          configure these settings and more.
+        </p>
+      </subsection>
+      <subsection name='Documentation'>
+        <ul>
+          <li>
+            Committed code <i>must</i> include full javadoc.
+          </li>
+          <li>
+            All component contracts <i>must</i> be fully specified in the javadoc class,
+            interface or method comments, including specification of acceptable ranges
+            of values, exceptions or special return values.
+          </li>
+          <li>
+            External references or full statements of definitions for all the
+            terms used in component documentation <i>must</i> be provided.
+          </li>
+          <li>
+            Commons Numbers javadoc generation supports embedded LaTeX formulas via the
+            <a href="http://www.mathjax.org">MathJax</a> javascript display engine.
+            To embed mathematical expressions formatted in LaTeX in javadoc, simply surround
+            the expression to be formatted with either <code>\(</code> and <code>\)</code>
+            for inline formulas (or <code>\[</code> and <code>\]</code> to have the formula
+            appear on a separate line).
+            For example,
+            <code>\(</code><code>a^2 + b^2 = c^2</code><code>\)</code>
+            will render an in-line formula
+            saying that (a, b, c) is a Pythagorean triplet: \( a^2 + b^2 = c^2 \).
+            <br/>
+            See the MathJax and LaTex documentation for details on how to represent formulas
+            and escape special characters.
+          </li>
+          <li>
+            Implementations <i>should</i> use standard algorithms and
+            references or full descriptions of all algorithms <i>should</i> be 
+            provided.
+          </li>
+          <li>
+            Additions and enhancements <i>should</i> include updates to the User
+            Guide.
+          </li>
+        </ul>
+      </subsection>
+      <subsection name='Exceptions'>
+        <ul>
+          <li>
+            Exceptions generated by Commons Numbers are all unchecked.
+          </li>
+          <li>
+            All public methods advertise all exceptions that they can generate.
+            Exceptions <i>must</i> be documented in Javadoc and the documentation
+            <i>must</i> include full description of the conditions under which
+            exceptions are thrown.
+          </li>
+        </ul>
+      </subsection>
+      <subsection name='Unit Tests'>
+        <ul>
+          <li>
+            Committed code <i>must</i> include unit tests.
+          </li>
+          <li>
+            Unit tests <i>should</i> provide full path coverage.
+          </li>
+          <li>
+            Unit tests <i>should</i> verify all boundary conditions specified in
+            interface contracts, including verification that exceptions are thrown or
+            special values (e.g. Double.NaN, Double.Infinity) are returned as
+            expected.
+          </li>
+        </ul>
+      </subsection>
+      <subsection name='Licensing and copyright'>
+        <ul>
+          <li>
+            All new source file submissions <i>must</i> include the Apache Software
+            License in a comment that begins the file.
+          </li>
+          <li>
+            All contributions must comply with the terms of the Apache 
+            <a href="http://www.apache.org/licenses/cla.pdf">Contributor License
+            Agreement (CLA)</a>.
+          </li>
+          <li>
+            Patches <i>must</i> be accompanied by a clear reference to a "source"
+            - if code has been "ported" from another language, clearly state the
+            source of the original implementation.  If the "expression" of a given
+            algorithm is derivative, please note the original source (textbook,
+            paper, etc.).
+          </li>
+          <li>
+            References to source materials covered by restrictive proprietary
+            licenses should be avoided.  In particular, contributions should not
+            implement or include references to algorithms in 
+            <a href="http://www.nr.com/">Numerical Recipes (NR)</a>.
+            Any questions about copyright or patent issues should be raised on
+            the commons-dev mailing list before contributing or committing code.
+          </li>
+        </ul>
+      </subsection>
+    </section>
+  </body>
 </document>

http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/81911e4c/src/site/xdoc/download_numbers.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/download_numbers.xml b/src/site/xdoc/download_numbers.xml
new file mode 100644
index 0000000..a144629
--- /dev/null
+++ b/src/site/xdoc/download_numbers.xml
@@ -0,0 +1,154 @@
+<?xml version="1.0"?>
+<!--
+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: download-page-template.xml                            |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ |                                                                      |
+ | 1) Re-generate using: mvn commons:download-page                      |
+ |                                                                      |
+ | 2) Set the following properties in the component's pom:              |
+ |    - commons.componentid (required, alphabetic, lower case)          |
+ |    - commons.release.version (required)                              |
+ |    - commons.release.name    (required)                              |
+ |    - commons.binary.suffix   (optional)                              |
+ |      (defaults to "-bin", set to "" for pre-maven2 releases)         |
+ |    - commons.release.desc    (optional)                              |
+ |    - commons.release.subdir  (optional)                              |
+ |                                                                      |
+ |    - commons.release.2/3.version       (conditional)                 |
+ |    - commons.release.2/3.name          (conditional)                 |
+ |    - commons.release.2/3.binary.suffix (optional)                    |
+ |    - commons.release.2/3.desc          (optional)                    |
+ |    - commons.release.2/3.subdir        (optional)                    |
+ |                                                                      |
+ | 3) Example Properties                                                |
+ |    (commons.release.name inherited by parent:                        |
+ |     ${project.artifactId}-${commons.release.version}                 |
+ |                                                                      |
+ |  <properties>                                                        |
+ |    <commons.componentid>math</commons.componentid>                   |
+ |    <commons.release.version>1.2</commons.release.version>            |
+ |  </properties>                                                       |
+ |                                                                      |
+ +======================================================================+
+-->
+<document>
+  <properties>
+    <title>Download Apache Commons Numbers</title>
+    <author email="dev@commons.apache.org">Apache Commons Documentation Team</author>
+  </properties>
+  <body>
+    <section name="Download Apache Commons Numbers">
+    <subsection name="Using a Mirror">
+      <p>
+        We recommend you use a mirror to download our release
+        builds, but you <strong>must</strong> <a href="http://www.apache.org/info/verification.html">verify the integrity</a> of
+        the downloaded files using signatures downloaded from our main
+        distribution directories. Recent releases (48 hours) may not yet
+        be available from all the mirrors.
+      </p>
+
+      <p>
+        You are currently using <b>[preferred]</b>.  If you
+        encounter a problem with this mirror, please select another
+        mirror.  If all mirrors are failing, there are <i>backup</i>
+        mirrors (at the end of the mirrors list) that should be
+        available.
+        <br></br>
+        [if-any logo]<a href="[link]"><img align="right" src="[logo]" border="0"></img></a>[end]
+      </p>
+
+      <form action="[location]" method="get" id="SelectMirror">
+        <p>
+          Other mirrors:
+          <select name="Preferred">
+          [if-any http]
+            [for http]<option value="[http]">[http]</option>[end]
+          [end]
+          [if-any ftp]
+            [for ftp]<option value="[ftp]">[ftp]</option>[end]
+          [end]
+          [if-any backup]
+            [for backup]<option value="[backup]">[backup] (backup)</option>[end]
+          [end]
+          </select>
+          <input type="submit" value="Change"></input>
+        </p>
+      </form>
+
+      <p>
+        It is essential that you
+        <a href="https://www.apache.org/info/verification.html">verify the integrity</a>
+        of downloaded files, preferably using the <code>PGP</code> signature (<code>*.asc</code> files);
+        failing that using the <code>MD5</code> hash (<code>*.md5</code> checksum files).
+      </p>
+      <p>
+        The <a href="https://www.apache.org/dist/commons/KEYS">KEYS</a>
+        file contains the public PGP keys used by Apache Commons developers
+        to sign releases.
+      </p>
+    </subsection>
+    </section>
+    <section name="Apache Commons Numbers 1.0 (requires Java 7+)">
+      <subsection name="Binaries">
+        <table>
+          <tr>
+              <td><a href="[preferred]/commons/numbers/binaries/commons-numbers-1.0-SNAPSHOT-bin.tar.gz">commons-numbers-1.0-SNAPSHOT-bin.tar.gz</a></td>
+              <td><a href="https://www.apache.org/dist/commons/numbers/binaries/commons-numbers-1.0-SNAPSHOT-bin.tar.gz.md5">md5</a></td>
+              <td><a href="https://www.apache.org/dist/commons/numbers/binaries/commons-numbers-1.0-SNAPSHOT-bin.tar.gz.asc">pgp</a></td>
+          </tr>
+          <tr>
+              <td><a href="[preferred]/commons/numbers/binaries/commons-numbers-1.0-SNAPSHOT-bin.zip">commons-numbers-1.0-SNAPSHOT-bin.zip</a></td>
+              <td><a href="https://www.apache.org/dist/commons/numbers/binaries/commons-numbers-1.0-SNAPSHOT-bin.zip.md5">md5</a></td>
+              <td><a href="https://www.apache.org/dist/commons/numbers/binaries/commons-numbers-1.0-SNAPSHOT-bin.zip.asc">pgp</a></td>
+          </tr>
+        </table>
+      </subsection>
+      <subsection name="Source">
+        <table>
+          <tr>
+              <td><a href="[preferred]/commons/numbers/source/commons-numbers-1.0-SNAPSHOT-src.tar.gz">commons-numbers-1.0-SNAPSHOT-src.tar.gz</a></td>
+              <td><a href="https://www.apache.org/dist/commons/numbers/source/commons-numbers-1.0-SNAPSHOT-src.tar.gz.md5">md5</a></td>
+              <td><a href="https://www.apache.org/dist/commons/numbers/source/commons-numbers-1.0-SNAPSHOT-src.tar.gz.asc">pgp</a></td>
+          </tr>
+          <tr>
+              <td><a href="[preferred]/commons/numbers/source/commons-numbers-1.0-SNAPSHOT-src.zip">commons-numbers-1.0-SNAPSHOT-src.zip</a></td>
+              <td><a href="https://www.apache.org/dist/commons/numbers/source/commons-numbers-1.0-SNAPSHOT-src.zip.md5">md5</a></td>
+              <td><a href="https://www.apache.org/dist/commons/numbers/source/commons-numbers-1.0-SNAPSHOT-src.zip.asc">pgp</a></td>
+          </tr>
+        </table>
+      </subsection>
+    </section>
+    <section name="Archives">
+        <p>
+          Older releases can be obtained from the archives.
+        </p>
+        <ul>
+          <li class="download"><a href="[preferred]/commons/numbers/">browse download area</a></li>
+          <li><a href="https://archive.apache.org/dist/commons/numbers/">archives...</a></li>
+        </ul>
+    </section>
+  </body>
+</document>

http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/81911e4c/src/site/xdoc/issue-tracking.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/issue-tracking.xml b/src/site/xdoc/issue-tracking.xml
index 237c4c3..222833a 100644
--- a/src/site/xdoc/issue-tracking.xml
+++ b/src/site/xdoc/issue-tracking.xml
@@ -43,35 +43,35 @@ limitations under the License.
 -->
 <document>
   <properties>
-    <title>Commons Math Issue tracking</title>
-    <author email="dev@commons.apache.org">Commons Documentation Team</author>
+    <title>Apache Commons Numbers Issue tracking</title>
+    <author email="dev@commons.apache.org">Apache Commons Documentation Team</author>
   </properties>
   <body>
 
-    <section name="Commons Math Issue tracking">
+    <section name="Apache Commons Numbers Issue tracking">
       <p>
-      Commons Math uses <a href="http://issues.apache.org/jira/">ASF JIRA</a> for tracking issues.
-      See the <a href="http://issues.apache.org/jira/browse/MATH">Commons Math JIRA project page</a>.
+      Apache Commons Numbers uses <a href="https://issues.apache.org/jira/">ASF JIRA</a> for tracking issues.
+      See the <a href="https://issues.apache.org/jira/browse/NUMBERS">Apache Commons Numbers 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 Math please do the following:
+      Apache Commons Numbers please do the following:
       <ol>
-        <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310485&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=12310485&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=12310485&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=12310485&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=12310485&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=12310485&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 Math are all unpaid volunteers</li>
+        <li>the developers of Apache Commons Numbers 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=12310485&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=1&amp;status=3&amp;status=4">All Open Commons Math bugs</a></li>
-        <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310485&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=5&amp;status=6">All Resolved Commons Math bugs</a></li>
-        <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310485&amp;sorter/field=issuekey&amp;sorter/order=DESC">All Commons Math bugs</a></li>
+        <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310485&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=1&amp;status=3&amp;status=4">All Open Apache Commons Numbers bugs</a></li>
+        <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310485&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=5&amp;status=6">All Resolved Apache Commons Numbers bugs</a></li>
+        <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310485&amp;sorter/field=issuekey&amp;sorter/order=DESC">All Apache Commons Numbers bugs</a></li>
       </ul>
       </p>
     </section>

http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/81911e4c/src/site/xdoc/mail-lists.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/mail-lists.xml b/src/site/xdoc/mail-lists.xml
index d1f1de8..7461af4 100644
--- a/src/site/xdoc/mail-lists.xml
+++ b/src/site/xdoc/mail-lists.xml
@@ -41,42 +41,45 @@ limitations under the License.
 -->
 <document>
   <properties>
-    <title>Commons Math Mailing Lists</title>
-    <author email="dev@commons.apache.org">Commons Documentation Team</author>
+    <title>Apache Commons Numbers 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 Math</a> shares mailing lists with all the other 
+        <a href="index.html">Apache Commons Numbers</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,
         for example:
         <ul>
-          <li>[math] Problem with the ...</li>
+          <li>[numbers] Problem with the ...</li>
         </ul>
       </p>
       <p>
-        Questions related to the usage of Commons Math should be posted to the
+        Questions related to the usage of Apache Commons Numbers 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 Math.
+        is for questions and discussion related to the development of Apache Commons Numbers.
         <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 Math Mailing Lists">
+    <section name="Apache Commons Numbers Mailing Lists">
       <p>
-        <strong>Please prefix the subject line of any messages for <a href="index.html">Commons Math</a>
-        with <i>[math]</i></strong> - <i>thanks!</i>
+        <strong>Please prefix the subject line of any messages for <a href="index.html">Apache Commons Numbers</a>
+        with <i>[numbers]</i></strong> - <i>thanks!</i>
         <br />
         <br />
       </p>
@@ -96,12 +99,12 @@ limitations under the License.
           <td>
             <strong>Commons User List</strong>
             <br /><br />
-            Questions on using Commons Math.
+            Questions on using Apache Commons Numbers.
             <br /><br />
           </td>
           <td><a href="mailto:user-subscribe@commons.apache.org">Subscribe</a></td>
           <td><a href="mailto:user-unsubscribe@commons.apache.org">Unsubscribe</a></td>
-          <td><a href="mailto:user@commons.apache.org?subject=[math]">Post</a></td>
+          <td><a href="mailto:user@commons.apache.org?subject=[numbers]">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 />
@@ -114,12 +117,12 @@ limitations under the License.
           <td>
             <strong>Commons Developer List</strong>
             <br /><br />
-            Discussion of development of Commons Math.
+            Discussion of development of Apache Commons Numbers.
             <br /><br />
           </td>
           <td><a href="mailto:dev-subscribe@commons.apache.org">Subscribe</a></td>
           <td><a href="mailto:dev-unsubscribe@commons.apache.org">Unsubscribe</a></td>
-          <td><a href="mailto:dev@commons.apache.org?subject=[math]">Post</a></td>
+          <td><a href="mailto:dev@commons.apache.org?subject=[numbers]">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 />
@@ -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