From 2e8128a14cddb5c64c5fcfa5c1ebff74f47dc589 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Darius=20Nea=C8=9Bu?= Date: Tue, 9 Dec 2025 02:02:00 +0200 Subject: [PATCH] December 2025 docs sync --- docs/beman_library_maturity_model.md | 51 ++++++++++++++++++++++++++-- docs/beman_standard.md | 2 ++ docs/governance.md | 10 +++--- 3 files changed, 56 insertions(+), 7 deletions(-) diff --git a/docs/beman_library_maturity_model.md b/docs/beman_library_maturity_model.md index ba708d1..f0efb80 100644 --- a/docs/beman_library_maturity_model.md +++ b/docs/beman_library_maturity_model.md @@ -20,7 +20,7 @@ These libraries may deviate from the Beman Standard due to incompleteness, lack ### Production ready. API may undergo changes. -These Beman-compliant libraries are production-ready, fully implementing the target paper with complete testing and documentation. Users should be aware that future API changes are possible and that standardization is not guaranteed. +These Beman-compliant libraries are production-ready, fully implementing the target paper with complete testing and documentation. Users should be aware that future API changes are possible and that standardization is not guaranteed. See below for details on the requirements to transition to production-ready. > These libraries are recommended for production usage. @@ -42,6 +42,53 @@ Transition examples: * They were [Production ready. Stable API.](./beman_library_maturity_model.md#production-ready-stable-api) at some point, but are no longer developed or maintained, being superseded by native compiler implementations - `Mature retirement`. -* They were [Production ready. API may undergo changes.](./beman_library_maturity_model.md#production-ready-api-may-undergo-changes) at some point, but are no longer developed or maintained, being rejected from the ISO C+ Standardization - `Early retirement`. +* They were [Production ready. API may undergo changes.](./beman_library_maturity_model.md#production-ready-api-may-undergo-changes) at some point, but are no longer developed or maintained, being rejected from the ISO C++ Standardization - `Early retirement`. * They were [Under development and not yet ready for production use.](./beman_library_maturity_model.md#under-development-and-not-yet-ready-for-production-use) at some point and were abandoned - `Early retirement`. + + +## Review Process for Transitioning a Library to “Production Ready” + +For a Beman Project library from **Under Development** to **Production Ready** status a formal review needs to be completed. +The intent is to ensure that every production-ready library meets the Beman standard for quality, completeness, and +documentation, and that it has received sufficient community review and testing. + +--- + +### Review Process Details + + +1. **Review Logistics** + Typically this is requested by the library author, but any community member that feels a library is ready can suggest + a review. The review will be managed by one or more leads or an lead appointee/volunteer. + + A post is made on [Discourse](https://discourse.bemanproject.org) announcing the start of a **two-week library review** period. + The announcement should include: + + * The released version of the library to review. + * Link to a PR to review for review comments. + - Note: The PR may not have much diff content but is the place for gathering feedback. + * Any other guidance for the reviewers. + +3. **Review Criteria** + To be eligible for *Production Ready* status, a library must demonstrate that it: + + * Meets the **Beman Standard** with deviations documented (passes beman.tidy checks). + * Has **comprehensive unit test coverage** validating functionality and edge cases. + * Includes **complete and accurate documentation**, including tutorial, design rationale, and examples. + + Note that much of the design documentation may simply reference the WG21 paper. + Also note that since the current documentation system is a work in progress, docs should be Markdown for now. + +4. **Community Evaluation** + During the review period, the community is encouraged to: + + * Build and test the library on supported platforms. + * Review its design and documentation. + * Provide feedback and raise issues for discussion. + +4. **Approval Requirements** + A library may transition to *Production Ready* status only after: + + * Demonstrated **positive community consensus** that the review criteria have been met as determined by **at least two project leads**, or + * in the rare case there is lack of consensus, the leads make a call. diff --git a/docs/beman_standard.md b/docs/beman_standard.md index e6ceb00..78a57eb 100644 --- a/docs/beman_standard.md +++ b/docs/beman_standard.md @@ -329,6 +329,8 @@ If the library has been deployed onto Compiler Explorer, add this badge and repl [Give *std::optional* Range Support (P3168R1)](https://wg21.link/P3168R1). ``` +Note that specifying the revision number is optional. + ### **[readme.library_status]** **Requirement**: Following the implements section and a newline, the `README.md` must indicate the **current** library status with respect to the [Beman library maturity model](https://github.com/bemanproject/beman/blob/main/docs/beman_library_maturity_model.md). An extra badge must be added to the `README.md` to visually indicate the library status (check `[readme.badges]`). Note: The full library status history can be found in the GitHub release notes. diff --git a/docs/governance.md b/docs/governance.md index 13f683c..2e6d409 100644 --- a/docs/governance.md +++ b/docs/governance.md @@ -12,7 +12,7 @@ The Beman Project is dedicated to providing the guidance and facilities to ensur We help library authors with development best practices, peer review, and contributing to the C++ standard. We distribute the libraries proposed for standardization to facilitate early usage and feedback. -The Beman project is named in memory of Beman Dawes - co-founder of [Boost](https://www.boost.org). +The Beman Project is named in memory of Beman Dawes - co-founder of [Boost](https://www.boost.org). # 2. Membership @@ -39,7 +39,7 @@ Beman Leads are currently: Jeff Garland, Inbal Levi, and Eddie Nolan. ### 3.1.2 Adding and removing Beman Leads -Any member of Beman Project Leads may step down or be replaced when they are no longer able to contribute effectively. +Any member of Beman Project Leads may step down or be replaced when they are no longer able to contribute effectively. The Beman Project Leads can nominate and decide on adding, removing, or replacing members by a majority decision. ## 3.2 Beman Project Contributors: @@ -56,7 +56,7 @@ The Beman Project Library Authors are the Library authors who are maintaining an ### 3.3.3 Adding and removing Beman Project Library Authors: -Beman Project Library Authors apply for acceptance into Beman Project when they have reached the point of path toward standardization. +Beman Project Library Authors apply for acceptance into Beman Project when they have reached the point of path toward standardization. This would be the submission of a Paper to the Committee, request to have a library to help write their paper, or a similar path. Removal as a Beman Project Library Author may be done when the library no longer becomes part of the Beman Project. @@ -65,8 +65,8 @@ Removal as a Beman Project Library Author may be done when the library no longer # 4.1 Consensus Decision-Making: -Beman Project strives to make decisions through consensus among the Project Contributors and the Project Leads. -Proposals on the best way to proceed should be discussed in good faith. +Beman Project strives to make decisions through consensus among the Project Contributors and the Project Leads. +Proposals on the best way to proceed should be discussed in good faith. Beman Project Leads ultimately decide the direction of the Project. # 5. Code of Conduct