From 83cea6b96c4f8b728f63d5b045b03015dd8a0bf1 Mon Sep 17 00:00:00 2001 From: tison Date: Sun, 4 Oct 2026 11:04:49 +0800 Subject: [PATCH 1/2] Fix release licensing metadata and build documentation --- .rat-excludes | 5 ----- CODE_OF_CONDUCT.md | 19 +++++++++++++++++++ CONTRIBUTING.md | 21 ++++++++++++++++++++- LICENSE | 34 ---------------------------------- NOTICE | 2 +- README.md | 21 ++++++++++++++++++++- 6 files changed, 60 insertions(+), 42 deletions(-) diff --git a/.rat-excludes b/.rat-excludes index 3c5bcd39..584a1bd9 100644 --- a/.rat-excludes +++ b/.rat-excludes @@ -12,11 +12,6 @@ fdlibm_log\.hpp # Dotfiles and repository metadata with no comment convention. \..* # -# Documentation. -README\.md -CONTRIBUTING\.md -CODE_OF_CONDUCT\.md -# # Generated and template files consumed by the build. Doxyfile version\.cfg\.in diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 0bdf0791..9c1b8ed6 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,3 +1,22 @@ + + # Code of Conduct We adhere to the Apache Software Foundation's [Code of Conduct](https://www.apache.org/foundation/policies/conduct). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 65f0324f..21270269 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,22 @@ + + # Contributing ## How We Communicate @@ -47,4 +66,4 @@ Proposed changes to the code or documentation are usually done through GitHub Pu * Major changes to the code such as API or architectural changes or new sketch algorithms must be discussed on or on a GitHub issue as these will require additional design and compatibility reviews. These changes must receive at least three (+1) votes from committers. If the author is already a committer, than two additional committers must vote (+1). ### Becoming a committer -We welcome anyone who is eager to continue to contribute to the DataSketches mission of providing open source, production quality sketch algorithms and become part of our team. Please send us a message on where we can give you some guidance. After you have made some successful contributions, the current committers will discuss your candidacy for becoming a committer. You can also review the [Apache policies on becoming a committer](https://community.apache.org/contributors/index.html) as well as our [New Committer Process](https://datasketches.apache.org/docs/Community/NewCommitterProcess.html) for selecting and inviting a committer to join our project. \ No newline at end of file +We welcome anyone who is eager to continue to contribute to the DataSketches mission of providing open source, production quality sketch algorithms and become part of our team. Please send us a message on where we can give you some guidance. After you have made some successful contributions, the current committers will discuss your candidacy for becoming a committer. You can also review the [Apache policies on becoming a committer](https://community.apache.org/contributors/index.html) as well as our [New Committer Process](https://datasketches.apache.org/docs/Community/NewCommitterProcess.html) for selecting and inviting a committer to join our project. diff --git a/LICENSE b/LICENSE index 3965c5eb..a1117417 100644 --- a/LICENSE +++ b/LICENSE @@ -214,40 +214,6 @@ APPENDIX B: Additional licenses relevant to this product. conditions of the following licenses. - ============================================================= - Boost License (https://www.boost.org/LICENSE_1_0.txt) - ============================================================= - Original source: - https://github.com/catchorg/Catch2/blob/v2.x/LICENSE.txt - - Boost Software License - Version 1.0 - August 17th, 2003 - - Permission is hereby granted, free of charge, to any person or organization - obtaining a copy of the software and accompanying documentation covered by - this license (the "Software") to use, reproduce, display, distribute, - execute, and transmit the Software, and to prepare derivative works of the - Software, and to permit third-parties to whom the Software is furnished to - do so, all subject to the following: - - The copyright notices in the Software and this entire statement, including - the above license grant, this restriction and the following disclaimer, - must be included in all copies of the Software, in whole or in part, and - all derivative works of the Software, unless such copies or derivative - works are solely in the form of machine-executable object code generated by - a source language processor. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT - SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE - FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, - ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER - DEALINGS IN THE SOFTWARE. - ------------------------------------------------------------- - Code Locations: - Found in the Catch2 unit test code that is downloaded from github.com as part - of CMake configuration if configured to build tests. - ============================================================= MIT License ============================================================= diff --git a/NOTICE b/NOTICE index 11ba6f6c..14c1ff98 100644 --- a/NOTICE +++ b/NOTICE @@ -1,5 +1,5 @@ Apache DataSketches C++ -Copyright 2025 The Apache Software Foundation +Copyright 2025-2026 The Apache Software Foundation Copyright 2015-2018 Yahoo Inc. Copyright 2019-2020 Verizon Media diff --git a/README.md b/README.md index d33f7caf..5e7015a7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ + + # Apache DataSketches Core C++ Library Component This is the core C++ component of the Apache DataSketches library. It contains all the key sketching algorithms from the Java implementation and can be accessed directly by user applications. @@ -21,7 +40,7 @@ This code requires C++11. This library is header-only. The provided build process is only for unit tests. -Building the unit tests requires CMake 3.12.0 or higher. +Building the unit tests requires CMake 3.16.0 or higher. Installing the latest CMake on OSX: `brew install cmake`. From a4605c8048426e221ff7d689d78b59e5d58e4f37 Mon Sep 17 00:00:00 2001 From: tison Date: Sun, 4 Oct 2026 11:11:28 +0800 Subject: [PATCH 2/2] Preserve documentation license audit exclusions --- .rat-excludes | 5 +++++ CODE_OF_CONDUCT.md | 19 ------------------- CONTRIBUTING.md | 21 +-------------------- README.md | 19 ------------------- 4 files changed, 6 insertions(+), 58 deletions(-) diff --git a/.rat-excludes b/.rat-excludes index 584a1bd9..3c5bcd39 100644 --- a/.rat-excludes +++ b/.rat-excludes @@ -12,6 +12,11 @@ fdlibm_log\.hpp # Dotfiles and repository metadata with no comment convention. \..* # +# Documentation. +README\.md +CONTRIBUTING\.md +CODE_OF_CONDUCT\.md +# # Generated and template files consumed by the build. Doxyfile version\.cfg\.in diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 9c1b8ed6..0bdf0791 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,22 +1,3 @@ - - # Code of Conduct We adhere to the Apache Software Foundation's [Code of Conduct](https://www.apache.org/foundation/policies/conduct). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 21270269..65f0324f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,22 +1,3 @@ - - # Contributing ## How We Communicate @@ -66,4 +47,4 @@ Proposed changes to the code or documentation are usually done through GitHub Pu * Major changes to the code such as API or architectural changes or new sketch algorithms must be discussed on or on a GitHub issue as these will require additional design and compatibility reviews. These changes must receive at least three (+1) votes from committers. If the author is already a committer, than two additional committers must vote (+1). ### Becoming a committer -We welcome anyone who is eager to continue to contribute to the DataSketches mission of providing open source, production quality sketch algorithms and become part of our team. Please send us a message on where we can give you some guidance. After you have made some successful contributions, the current committers will discuss your candidacy for becoming a committer. You can also review the [Apache policies on becoming a committer](https://community.apache.org/contributors/index.html) as well as our [New Committer Process](https://datasketches.apache.org/docs/Community/NewCommitterProcess.html) for selecting and inviting a committer to join our project. +We welcome anyone who is eager to continue to contribute to the DataSketches mission of providing open source, production quality sketch algorithms and become part of our team. Please send us a message on where we can give you some guidance. After you have made some successful contributions, the current committers will discuss your candidacy for becoming a committer. You can also review the [Apache policies on becoming a committer](https://community.apache.org/contributors/index.html) as well as our [New Committer Process](https://datasketches.apache.org/docs/Community/NewCommitterProcess.html) for selecting and inviting a committer to join our project. \ No newline at end of file diff --git a/README.md b/README.md index 5e7015a7..dd7f8899 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,3 @@ - - # Apache DataSketches Core C++ Library Component This is the core C++ component of the Apache DataSketches library. It contains all the key sketching algorithms from the Java implementation and can be accessed directly by user applications.