This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-numbers.git
commit 87d252f54870b3eff452dc09e1d851048807781c
Author: Alex Herbert <aherb...@apache.org>
AuthorDate: Mon Aug 12 12:07:57 2024 +0100
Update README pages following release 1.2
---
README.md | 41 ++++++++++++--------
commons-numbers-angle/README.md | 45 ++++++++++++++--------
commons-numbers-arrays/README.md | 43 +++++++++++++--------
commons-numbers-bom/README.md | 37 +++++++++++-------
commons-numbers-combinatorics/README.md | 43 +++++++++++++--------
commons-numbers-complex/README.md | 43 +++++++++++++--------
commons-numbers-core/README.md | 43 +++++++++++++--------
.../README.md | 41 +++++++++++++-------
commons-numbers-examples/README.md | 33 ++++++++++------
commons-numbers-examples/examples-jmh/README.md | 33 ++++++++++------
commons-numbers-field/README.md | 43 +++++++++++++--------
commons-numbers-fraction/README.md | 43 +++++++++++++--------
commons-numbers-gamma/README.md | 43 +++++++++++++--------
commons-numbers-primes/README.md | 43 +++++++++++++--------
commons-numbers-quaternion/README.md | 43 +++++++++++++--------
commons-numbers-rootfinder/README.md | 43 +++++++++++++--------
16 files changed, 419 insertions(+), 241 deletions(-)
diff --git a/README.md b/README.md
index 478337a8..e83654de 100644
--- a/README.md
+++ b/README.md
@@ -43,10 +43,10 @@
Apache Commons Numbers
===================
-[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-numbers)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-bom/?gav=true)
[](https://sonarcloud.io/dashboard?id=commons-numbers)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-parent/)
The Apache Commons Numbers project provides number types and utilities.
@@ -70,8 +70,8 @@ The
[Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-
Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-numbers/download_numbers.cgi).
Alternatively, you can pull it from the central Maven repositories, for
example:
@@ -80,27 +80,35 @@ Alternatively, you can pull it from the central Maven
repositories, for example:
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-numbers-core</artifactId>
- <version>1.1</version>
+ <version>1.2</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-numbers-complex</artifactId>
- <version>1.1</version>
+ <version>1.2</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-numbers-quaternion</artifactId>
- <version>1.1</version>
+ <version>1.2</version>
</dependency>
```
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -109,20 +117,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-numbers-angle/README.md b/commons-numbers-angle/README.md
index 328702ad..7bfc9fe4 100644
--- a/commons-numbers-angle/README.md
+++ b/commons-numbers-angle/README.md
@@ -43,11 +43,11 @@
Apache Commons Numbers Angle
===================
-[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-numbers)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-angle/)
-[](https://javadoc.io/doc/org.apache.commons/commons-numbers-angle/1.1)
-
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-angle/?gav=true)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-angle/1.2)
+[
Utilities related to the concept of angle.
Documentation
@@ -55,29 +55,37 @@ Documentation
More information can be found on the [Apache Commons Numbers
homepage](https://commons.apache.org/proper/commons-numbers).
The
[Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-angle/apidocs)
can be browsed.
-Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list][ml].
+Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-numbers/download_numbers.cgi).
-Alternatively, you can pull it from the central Maven repositories:
+Alternatively, you can pull it from the central Maven repositories:
```xml
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-numbers-angle</artifactId>
- <version>1.1</version>
+ <version>1.2</version>
</dependency>
```
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -86,20 +94,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-numbers-arrays/README.md b/commons-numbers-arrays/README.md
index 0a308189..00b8b3e1 100644
--- a/commons-numbers-arrays/README.md
+++ b/commons-numbers-arrays/README.md
@@ -43,10 +43,10 @@
Apache Commons Numbers Arrays
===================
-[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-numbers)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-arrays/)
-[](https://javadoc.io/doc/org.apache.commons/commons-numbers-arrays/1.1)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-arrays/?gav=true)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-arrays/1.2)
Array utilities.
@@ -55,29 +55,37 @@ Documentation
More information can be found on the [Apache Commons Numbers
homepage](https://commons.apache.org/proper/commons-numbers).
The
[Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-arrays/apidocs)
can be browsed.
-Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list][ml].
+Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-numbers/download_numbers.cgi).
-Alternatively, you can pull it from the central Maven repositories:
+Alternatively, you can pull it from the central Maven repositories:
```xml
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-numbers-arrays</artifactId>
- <version>1.1</version>
+ <version>1.2</version>
</dependency>
```
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -86,20 +94,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-numbers-bom/README.md b/commons-numbers-bom/README.md
index 39cd4013..1f204305 100644
--- a/commons-numbers-bom/README.md
+++ b/commons-numbers-bom/README.md
@@ -25,16 +25,16 @@
Apache Commons Numbers (Bill of Materials)
===================
-This Bill of Materials POM can be used to ease dependency management when
referencing multiple Apache Commons Numbers artifacts.
+Bill of Materials (BOM) to aid in dependency management when referencing
multiple Apache Commons Numbers artifacts.
Documentation
-------------
More information can be found on the [Apache Commons Numbers
homepage](https://commons.apache.org/proper/commons-numbers).
-Questions related to the usage of Apache Commons Numbers Sampling should be
posted to the [user mailing list][ml].
+Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-numbers/download_numbers.cgi).
Alternatively, you can pull it from the central Maven repositories and use
@@ -46,7 +46,7 @@ the Bill of Materials (BOM) for dependency management:
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-numbers-bom</artifactId>
- <version>1.1</version>
+ <version>1.2</version>
<type>pom</type>
<scope>import</scope>
</dependency>
@@ -54,13 +54,21 @@ the Bill of Materials (BOM) for dependency management:
</dependencyManagement>
```
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -69,20 +77,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-numbers-combinatorics/README.md
b/commons-numbers-combinatorics/README.md
index dfb3c715..fbb22b5c 100644
--- a/commons-numbers-combinatorics/README.md
+++ b/commons-numbers-combinatorics/README.md
@@ -43,10 +43,10 @@
Apache Commons Numbers Combinatorics
===================
-[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-numbers)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-combinatorics/)
-[](https://javadoc.io/doc/org.apache.commons/commons-numbers-combinatorics/1.1)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-combinatorics/?gav=true)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-combinatorics/1.2)
Combinatorics utilities such as factorial and binomial coefficients.
@@ -55,29 +55,37 @@ Documentation
More information can be found on the [Apache Commons Numbers
homepage](https://commons.apache.org/proper/commons-numbers).
The
[Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-combinatorics/apidocs)
can be browsed.
-Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list][ml].
+Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-numbers/download_numbers.cgi).
-Alternatively, you can pull it from the central Maven repositories:
+Alternatively, you can pull it from the central Maven repositories:
```xml
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-numbers-combinatorics</artifactId>
- <version>1.1</version>
+ <version>1.2</version>
</dependency>
```
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -86,20 +94,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-numbers-complex/README.md
b/commons-numbers-complex/README.md
index 10cab144..e559f4ae 100644
--- a/commons-numbers-complex/README.md
+++ b/commons-numbers-complex/README.md
@@ -43,10 +43,10 @@
Apache Commons Numbers Complex
===================
-[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-numbers)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-complex/)
-[](https://javadoc.io/doc/org.apache.commons/commons-numbers-complex/1.1)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-complex/?gav=true)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-complex/1.2)
Complex numbers.
@@ -55,29 +55,37 @@ Documentation
More information can be found on the [Apache Commons Numbers
homepage](https://commons.apache.org/proper/commons-numbers).
The
[Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-complex/apidocs)
can be browsed.
-Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list][ml].
+Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-numbers/download_numbers.cgi).
-Alternatively, you can pull it from the central Maven repositories:
+Alternatively, you can pull it from the central Maven repositories:
```xml
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-numbers-complex</artifactId>
- <version>1.1</version>
+ <version>1.2</version>
</dependency>
```
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -86,20 +94,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-numbers-core/README.md b/commons-numbers-core/README.md
index ac2aeafa..1b13e3ce 100644
--- a/commons-numbers-core/README.md
+++ b/commons-numbers-core/README.md
@@ -43,10 +43,10 @@
Apache Commons Numbers Core
===================
-[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-numbers)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-core/)
-[](https://javadoc.io/doc/org.apache.commons/commons-numbers-core/1.1)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-core/?gav=true)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-core/1.2)
Basic utilities.
@@ -55,29 +55,37 @@ Documentation
More information can be found on the [Apache Commons Numbers
homepage](https://commons.apache.org/proper/commons-numbers).
The
[Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-core/apidocs)
can be browsed.
-Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list][ml].
+Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-numbers/download_numbers.cgi).
-Alternatively, you can pull it from the central Maven repositories:
+Alternatively, you can pull it from the central Maven repositories:
```xml
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-numbers-core</artifactId>
- <version>1.1</version>
+ <version>1.2</version>
</dependency>
```
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -86,20 +94,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-numbers-examples/examples-jmh/README.md
b/commons-numbers-docs/README.md
similarity index 74%
copy from commons-numbers-examples/examples-jmh/README.md
copy to commons-numbers-docs/README.md
index e272903a..2f37066f 100644
--- a/commons-numbers-examples/examples-jmh/README.md
+++ b/commons-numbers-docs/README.md
@@ -40,29 +40,39 @@
| |
+======================================================================+
--->
-Apache Commons Numbers JMH Benchmark
+Apache Commons Numbers Documentation
===================
-Code for running JMH benchmarks that assess performance.
- Code in this module is not part of the public API.
+[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
+
+Aggregator module to generate Apache Commons Numbers documentation.
Documentation
-------------
More information can be found on the [Apache Commons Numbers
homepage](https://commons.apache.org/proper/commons-numbers).
-Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list][ml].
+The
[Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-docs/apidocs)
can be browsed.
+Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-numbers/download_numbers.cgi).
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -71,20 +81,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-numbers-examples/README.md
b/commons-numbers-examples/README.md
index 4d817da1..8e9d6f34 100644
--- a/commons-numbers-examples/README.md
+++ b/commons-numbers-examples/README.md
@@ -52,19 +52,27 @@ Documentation
-------------
More information can be found on the [Apache Commons Numbers
homepage](https://commons.apache.org/proper/commons-numbers).
-Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list][ml].
+Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-numbers/download_numbers.cgi).
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -73,20 +81,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-numbers-examples/examples-jmh/README.md
b/commons-numbers-examples/examples-jmh/README.md
index e272903a..ab634511 100644
--- a/commons-numbers-examples/examples-jmh/README.md
+++ b/commons-numbers-examples/examples-jmh/README.md
@@ -50,19 +50,27 @@ Documentation
-------------
More information can be found on the [Apache Commons Numbers
homepage](https://commons.apache.org/proper/commons-numbers).
-Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list][ml].
+Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-numbers/download_numbers.cgi).
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -71,20 +79,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-numbers-field/README.md b/commons-numbers-field/README.md
index 8bdc4c86..3a9f8b96 100644
--- a/commons-numbers-field/README.md
+++ b/commons-numbers-field/README.md
@@ -43,10 +43,10 @@
Apache Commons Numbers Field
===================
-[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-numbers)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-field/)
-[](https://javadoc.io/doc/org.apache.commons/commons-numbers-field/1.1)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-field/?gav=true)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-field/1.2)
Utilities related to the concept of field.
@@ -55,29 +55,37 @@ Documentation
More information can be found on the [Apache Commons Numbers
homepage](https://commons.apache.org/proper/commons-numbers).
The
[Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-field/apidocs)
can be browsed.
-Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list][ml].
+Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-numbers/download_numbers.cgi).
-Alternatively, you can pull it from the central Maven repositories:
+Alternatively, you can pull it from the central Maven repositories:
```xml
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-numbers-field</artifactId>
- <version>1.1</version>
+ <version>1.2</version>
</dependency>
```
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -86,20 +94,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-numbers-fraction/README.md
b/commons-numbers-fraction/README.md
index aa99c7fe..f47d3be1 100644
--- a/commons-numbers-fraction/README.md
+++ b/commons-numbers-fraction/README.md
@@ -43,10 +43,10 @@
Apache Commons Numbers Fraction
===================
-[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-numbers)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-fraction/)
-[](https://javadoc.io/doc/org.apache.commons/commons-numbers-fraction/1.1)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-fraction/?gav=true)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-fraction/1.2)
Fraction utilities.
@@ -55,29 +55,37 @@ Documentation
More information can be found on the [Apache Commons Numbers
homepage](https://commons.apache.org/proper/commons-numbers).
The
[Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-fraction/apidocs)
can be browsed.
-Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list][ml].
+Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-numbers/download_numbers.cgi).
-Alternatively, you can pull it from the central Maven repositories:
+Alternatively, you can pull it from the central Maven repositories:
```xml
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-numbers-fraction</artifactId>
- <version>1.1</version>
+ <version>1.2</version>
</dependency>
```
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -86,20 +94,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-numbers-gamma/README.md b/commons-numbers-gamma/README.md
index b97d3638..1df0272e 100644
--- a/commons-numbers-gamma/README.md
+++ b/commons-numbers-gamma/README.md
@@ -43,10 +43,10 @@
Apache Commons Numbers Gamma
===================
-[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-numbers)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-gamma/)
-[](https://javadoc.io/doc/org.apache.commons/commons-numbers-gamma/1.1)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-gamma/?gav=true)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-gamma/1.2)
Gamma family of functions.
@@ -55,29 +55,37 @@ Documentation
More information can be found on the [Apache Commons Numbers
homepage](https://commons.apache.org/proper/commons-numbers).
The
[Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-gamma/apidocs)
can be browsed.
-Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list][ml].
+Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-numbers/download_numbers.cgi).
-Alternatively, you can pull it from the central Maven repositories:
+Alternatively, you can pull it from the central Maven repositories:
```xml
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-numbers-gamma</artifactId>
- <version>1.1</version>
+ <version>1.2</version>
</dependency>
```
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -86,20 +94,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-numbers-primes/README.md b/commons-numbers-primes/README.md
index 8b15b3f5..88c9afde 100644
--- a/commons-numbers-primes/README.md
+++ b/commons-numbers-primes/README.md
@@ -43,10 +43,10 @@
Apache Commons Numbers Primes
===================
-[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-numbers)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-primes/)
-[](https://javadoc.io/doc/org.apache.commons/commons-numbers-primes/1.1)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-primes/?gav=true)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-primes/1.2)
Utilities related to prime numbers.
@@ -55,29 +55,37 @@ Documentation
More information can be found on the [Apache Commons Numbers
homepage](https://commons.apache.org/proper/commons-numbers).
The
[Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-primes/apidocs)
can be browsed.
-Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list][ml].
+Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-numbers/download_numbers.cgi).
-Alternatively, you can pull it from the central Maven repositories:
+Alternatively, you can pull it from the central Maven repositories:
```xml
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-numbers-primes</artifactId>
- <version>1.1</version>
+ <version>1.2</version>
</dependency>
```
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -86,20 +94,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-numbers-quaternion/README.md
b/commons-numbers-quaternion/README.md
index 0699effc..b6dbef97 100644
--- a/commons-numbers-quaternion/README.md
+++ b/commons-numbers-quaternion/README.md
@@ -43,10 +43,10 @@
Apache Commons Numbers Quaternion
===================
-[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-numbers)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-quaternion/)
-[](https://javadoc.io/doc/org.apache.commons/commons-numbers-quaternion/1.1)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-quaternion/?gav=true)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-quaternion/1.2)
Quaternion numbers.
@@ -55,29 +55,37 @@ Documentation
More information can be found on the [Apache Commons Numbers
homepage](https://commons.apache.org/proper/commons-numbers).
The
[Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-quaternion/apidocs)
can be browsed.
-Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list][ml].
+Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-numbers/download_numbers.cgi).
-Alternatively, you can pull it from the central Maven repositories:
+Alternatively, you can pull it from the central Maven repositories:
```xml
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-numbers-quaternion</artifactId>
- <version>1.1</version>
+ <version>1.2</version>
</dependency>
```
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -86,20 +94,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-numbers-rootfinder/README.md
b/commons-numbers-rootfinder/README.md
index 4bf3497f..5d06d538 100644
--- a/commons-numbers-rootfinder/README.md
+++ b/commons-numbers-rootfinder/README.md
@@ -43,10 +43,10 @@
Apache Commons Numbers Root Finder
===================
-[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-numbers/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-numbers)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-rootfinder/)
-[](https://javadoc.io/doc/org.apache.commons/commons-numbers-rootfinder/1.1)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-rootfinder/?gav=true)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-rootfinder/1.2)
Root finding utilities.
@@ -55,29 +55,37 @@ Documentation
More information can be found on the [Apache Commons Numbers
homepage](https://commons.apache.org/proper/commons-numbers).
The
[Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-rootfinder/apidocs)
can be browsed.
-Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list][ml].
+Questions related to the usage of Apache Commons Numbers should be posted to
the [user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-numbers/download_numbers.cgi).
-Alternatively, you can pull it from the central Maven repositories:
+Alternatively, you can pull it from the central Maven repositories:
```xml
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-numbers-rootfinder</artifactId>
- <version>1.1</version>
+ <version>1.2</version>
</dependency>
```
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -86,20 +94,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
