Skip to content

Commit 3c31765

Browse files
committed
Update README pages following 1.7 release
1 parent d31fa67 commit 3c31765

16 files changed

Lines changed: 96 additions & 69 deletions

File tree

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
(the "License"); you may not use this file except in compliance with
77
the License. You may obtain a copy of the License at
88
9-
http://www.apache.org/licenses/LICENSE-2.0
9+
https://www.apache.org/licenses/LICENSE-2.0
1010
1111
Unless required by applicable law or agreed to in writing, software
1212
distributed under the License is distributed on an "AS IS" BASIS,
@@ -46,15 +46,17 @@ Apache Commons RNG
4646
[![Java CI](https://github.com/apache/commons-rng/actions/workflows/maven.yml/badge.svg)](https://github.com/apache/commons-rng/actions/workflows/maven.yml)
4747
[![Coverage Status](https://codecov.io/gh/apache/commons-rng/branch/master/graph/badge.svg)](https://app.codecov.io/gh/apache/commons-rng)
4848
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=commons-rng&metric=alert_status)](https://sonarcloud.io/dashboard?id=commons-rng)
49-
[![Maven Central](https://img.shields.io/maven-central/v/org.apache.commons/commons-rng-simple?label=Maven%20Central)](https://search.maven.org/artifact/org.apache.commons/commons-rng-simple/)
50-
[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-rng-simple/1.6.svg)](https://javadoc.io/doc/org.apache.commons/commons-rng-simple/1.6)
49+
[![Maven Central](https://img.shields.io/maven-central/v/org.apache.commons/commons-rng-parent?label=Maven%20Central)](https://search.maven.org/artifact/org.apache.commons/commons-rng-parent)
50+
[![CodeQL](https://github.com/apache/commons-rng/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/apache/commons-rng/actions/workflows/codeql-analysis.yml)
51+
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/apache/commons-rng/badge)](https://api.securityscorecards.dev/projects/github.com/apache/commons-rng)
5152

5253
The Apache Commons RNG project provides pure-Java implementation of pseudo-random generators.
5354

5455
Documentation
5556
-------------
5657

57-
More information can be found on the [Apache Commons RNG homepage](https://commons.apache.org/proper/commons-rng). The Javadoc for each of the modules can be browsed:
58+
More information can be found on the [Apache Commons RNG homepage](https://commons.apache.org/proper/commons-rng).
59+
The [Javadoc](https://commons.apache.org/proper/commons-rng/commons-rng-docs/apidocs) for each of the modules can be browsed:
5860

5961
- [Commons RNG Client API](https://commons.apache.org/proper/commons-rng/commons-rng-client-api/apidocs/)
6062
- [Commons RNG Core](https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/)
@@ -73,12 +75,12 @@ Alternatively, you can pull it from the central Maven repositories:
7375
<dependency>
7476
<groupId>org.apache.commons</groupId>
7577
<artifactId>commons-rng-simple</artifactId>
76-
<version>1.6</version>
78+
<version>1.7</version>
7779
</dependency>
7880
<dependency>
7981
<groupId>org.apache.commons</groupId>
8082
<artifactId>commons-rng-sampling</artifactId>
81-
<version>1.6</version>
83+
<version>1.7</version>
8284
</dependency>
8385
```
8486

@@ -98,7 +100,9 @@ There are some guidelines which will make applying PRs easier for us:
98100
+ No tabs! Please use spaces for indentation.
99101
+ Respect the existing code style for each file.
100102
+ 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.
101-
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn```.
103+
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`.
104+
+ Before you push a PR, run `mvn` (without arguments). This runs the default goal which contains all build checks.
105+
+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false -Pjacoco`
102106

103107
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
104108
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
@@ -119,7 +123,6 @@ Additional Resources
119123
+ [Apache Commons Homepage](https://commons.apache.org/)
120124
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
121125
+ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
122-
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
123126

124127
Apache Commons Components
125128
-------------------------

commons-rng-bom/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
(the "License"); you may not use this file except in compliance with
77
the License. You may obtain a copy of the License at
88
9-
http://www.apache.org/licenses/LICENSE-2.0
9+
https://www.apache.org/licenses/LICENSE-2.0
1010
1111
Unless required by applicable law or agreed to in writing, software
1212
distributed under the License is distributed on an "AS IS" BASIS,
@@ -46,7 +46,7 @@ the Bill of Materials (BOM) for dependency management:
4646
<dependency>
4747
<groupId>org.apache.commons</groupId>
4848
<artifactId>commons-rng-bom</artifactId>
49-
<version>1.6</version>
49+
<version>1.7</version>
5050
<type>pom</type>
5151
<scope>import</scope>
5252
</dependency>
@@ -62,7 +62,9 @@ There are some guidelines which will make applying PRs easier for us:
6262
+ No tabs! Please use spaces for indentation.
6363
+ Respect the existing code style for each file.
6464
+ 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.
65-
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn```.
65+
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`.
66+
+ Before you push a PR, run `mvn` (without arguments). This runs the default goal which contains all build checks.
67+
+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false -Pjacoco`
6668

6769
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
6870
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
@@ -83,7 +85,6 @@ Additional Resources
8385
+ [Apache Commons Homepage](https://commons.apache.org/)
8486
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
8587
+ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
86-
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
8788

8889
Apache Commons Components
8990
-------------------------

commons-rng-client-api/README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
(the "License"); you may not use this file except in compliance with
77
the License. You may obtain a copy of the License at
88
9-
http://www.apache.org/licenses/LICENSE-2.0
9+
https://www.apache.org/licenses/LICENSE-2.0
1010
1111
Unless required by applicable law or agreed to in writing, software
1212
distributed under the License is distributed on an "AS IS" BASIS,
@@ -45,8 +45,10 @@ Apache Commons RNG Client API
4545

4646
[![Java CI](https://github.com/apache/commons-rng/actions/workflows/maven.yml/badge.svg)](https://github.com/apache/commons-rng/actions/workflows/maven.yml)
4747
[![Coverage Status](https://codecov.io/gh/apache/commons-rng/branch/master/graph/badge.svg)](https://app.codecov.io/gh/apache/commons-rng)
48-
[![Maven Central](https://img.shields.io/maven-central/v/org.apache.commons/commons-rng-client-api?label=Maven%20Central)](https://search.maven.org/artifact/org.apache.commons/commons-rng-client-api/)
49-
[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-rng-client-api/1.6.svg)](https://javadoc.io/doc/org.apache.commons/commons-rng-client-api/1.6)
48+
[![Maven Central](https://img.shields.io/maven-central/v/org.apache.commons/commons-rng-client-api?label=Maven%20Central)](https://search.maven.org/artifact/org.apache.commons/commons-rng-client-api)
49+
[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-rng-client-api/1.8.svg)](https://javadoc.io/doc/org.apache.commons/commons-rng-client-api/1.8)
50+
[![CodeQL](https://github.com/apache/commons-rng/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/apache/commons-rng/actions/workflows/codeql-analysis.yml)
51+
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/apache/commons-rng/badge)](https://api.securityscorecards.dev/projects/github.com/apache/commons-rng)
5052

5153
API for client code that uses random numbers generators.
5254

@@ -67,7 +69,7 @@ Alternatively, you can pull it from the central Maven repositories:
6769
<dependency>
6870
<groupId>org.apache.commons</groupId>
6971
<artifactId>commons-rng-client-api</artifactId>
70-
<version>1.6</version>
72+
<version>1.8</version>
7173
</dependency>
7274
```
7375

@@ -87,7 +89,9 @@ There are some guidelines which will make applying PRs easier for us:
8789
+ No tabs! Please use spaces for indentation.
8890
+ Respect the existing code style for each file.
8991
+ 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.
90-
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn```.
92+
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`.
93+
+ Before you push a PR, run `mvn` (without arguments). This runs the default goal which contains all build checks.
94+
+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false -Pjacoco`
9195

9296
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
9397
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
@@ -108,7 +112,6 @@ Additional Resources
108112
+ [Apache Commons Homepage](https://commons.apache.org/)
109113
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
110114
+ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
111-
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
112115

113116
Apache Commons Components
114117
-------------------------

commons-rng-core/README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
(the "License"); you may not use this file except in compliance with
77
the License. You may obtain a copy of the License at
88
9-
http://www.apache.org/licenses/LICENSE-2.0
9+
https://www.apache.org/licenses/LICENSE-2.0
1010
1111
Unless required by applicable law or agreed to in writing, software
1212
distributed under the License is distributed on an "AS IS" BASIS,
@@ -45,8 +45,10 @@ Apache Commons RNG Core
4545

4646
[![Java CI](https://github.com/apache/commons-rng/actions/workflows/maven.yml/badge.svg)](https://github.com/apache/commons-rng/actions/workflows/maven.yml)
4747
[![Coverage Status](https://codecov.io/gh/apache/commons-rng/branch/master/graph/badge.svg)](https://app.codecov.io/gh/apache/commons-rng)
48-
[![Maven Central](https://img.shields.io/maven-central/v/org.apache.commons/commons-rng-core?label=Maven%20Central)](https://search.maven.org/artifact/org.apache.commons/commons-rng-core/)
49-
[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-rng-core/1.6.svg)](https://javadoc.io/doc/org.apache.commons/commons-rng-core/1.6)
48+
[![Maven Central](https://img.shields.io/maven-central/v/org.apache.commons/commons-rng-core?label=Maven%20Central)](https://search.maven.org/artifact/org.apache.commons/commons-rng-core)
49+
[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-rng-core/1.8.svg)](https://javadoc.io/doc/org.apache.commons/commons-rng-core/1.8)
50+
[![CodeQL](https://github.com/apache/commons-rng/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/apache/commons-rng/actions/workflows/codeql-analysis.yml)
51+
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/apache/commons-rng/badge)](https://api.securityscorecards.dev/projects/github.com/apache/commons-rng)
5052

5153
Pure Java implementations of random numbers generator algorithms.
5254
Code in this module should not be used directly by applications; please use
@@ -71,7 +73,7 @@ Alternatively, you can pull it from the central Maven repositories:
7173
<dependency>
7274
<groupId>org.apache.commons</groupId>
7375
<artifactId>commons-rng-core</artifactId>
74-
<version>1.6</version>
76+
<version>1.8</version>
7577
</dependency>
7678
```
7779

@@ -91,7 +93,9 @@ There are some guidelines which will make applying PRs easier for us:
9193
+ No tabs! Please use spaces for indentation.
9294
+ Respect the existing code style for each file.
9395
+ 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.
94-
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn```.
96+
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`.
97+
+ Before you push a PR, run `mvn` (without arguments). This runs the default goal which contains all build checks.
98+
+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false -Pjacoco`
9599

96100
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
97101
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
@@ -112,7 +116,6 @@ Additional Resources
112116
+ [Apache Commons Homepage](https://commons.apache.org/)
113117
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
114118
+ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
115-
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
116119

117120
Apache Commons Components
118121
-------------------------

commons-rng-docs/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
(the "License"); you may not use this file except in compliance with
77
the License. You may obtain a copy of the License at
88
9-
http://www.apache.org/licenses/LICENSE-2.0
9+
https://www.apache.org/licenses/LICENSE-2.0
1010
1111
Unless required by applicable law or agreed to in writing, software
1212
distributed under the License is distributed on an "AS IS" BASIS,
@@ -20,6 +20,7 @@
2020
|**** This file is ADAPTED from the README generated by the ****|
2121
|**** commons build plugin and must be edited ****|
2222
|**** ****|
23+
+======================================================================+
2324
--->
2425
Apache Commons RNG Documentation
2526
===================
@@ -44,7 +45,9 @@ There are some guidelines which will make applying PRs easier for us:
4445
+ No tabs! Please use spaces for indentation.
4546
+ Respect the existing code style for each file.
4647
+ 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.
47-
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn```.
48+
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`.
49+
+ Before you push a PR, run `mvn` (without arguments). This runs the default goal which contains all build checks.
50+
+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false -Pjacoco`
4851

4952
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
5053
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
@@ -65,7 +68,6 @@ Additional Resources
6568
+ [Apache Commons Homepage](https://commons.apache.org/)
6669
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
6770
+ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
68-
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
6971

7072
Apache Commons Components
7173
-------------------------

commons-rng-examples/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
(the "License"); you may not use this file except in compliance with
77
the License. You may obtain a copy of the License at
88
9-
http://www.apache.org/licenses/LICENSE-2.0
9+
https://www.apache.org/licenses/LICENSE-2.0
1010
1111
Unless required by applicable law or agreed to in writing, software
1212
distributed under the License is distributed on an "AS IS" BASIS,
@@ -48,7 +48,9 @@ There are some guidelines which will make applying PRs easier for us:
4848
+ No tabs! Please use spaces for indentation.
4949
+ Respect the existing code style for each file.
5050
+ 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.
51-
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn```.
51+
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`.
52+
+ Before you push a PR, run `mvn` (without arguments). This runs the default goal which contains all build checks.
53+
+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false -Pjacoco`
5254

5355
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
5456
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
@@ -69,7 +71,6 @@ Additional Resources
6971
+ [Apache Commons Homepage](https://commons.apache.org/)
7072
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
7173
+ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
72-
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
7374

7475
Apache Commons Components
7576
-------------------------

commons-rng-examples/examples-jmh/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
(the "License"); you may not use this file except in compliance with
77
the License. You may obtain a copy of the License at
88
9-
http://www.apache.org/licenses/LICENSE-2.0
9+
https://www.apache.org/licenses/LICENSE-2.0
1010
1111
Unless required by applicable law or agreed to in writing, software
1212
distributed under the License is distributed on an "AS IS" BASIS,
@@ -46,7 +46,9 @@ There are some guidelines which will make applying PRs easier for us:
4646
+ No tabs! Please use spaces for indentation.
4747
+ Respect the existing code style for each file.
4848
+ 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.
49-
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn```.
49+
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`.
50+
+ Before you push a PR, run `mvn` (without arguments). This runs the default goal which contains all build checks.
51+
+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false -Pjacoco`
5052

5153
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
5254
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
@@ -67,7 +69,6 @@ Additional Resources
6769
+ [Apache Commons Homepage](https://commons.apache.org/)
6870
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
6971
+ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
70-
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
7172

7273
Apache Commons Components
7374
-------------------------

0 commit comments

Comments
 (0)