Skip to content

Commit f2c7c19

Browse files
authored
Merge pull request #116 from neatudarius/issue/112-v2
More December docs sync
2 parents 3d88077 + 67dc9a6 commit f2c7c19

File tree

39 files changed

+198
-172
lines changed

39 files changed

+198
-172
lines changed

docs/beman_standard.md

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ needs. To make changes:
3838
1. Create a [discourse topic](https://discourse.boost.org) detailing the change
3939
and how it aligns with the core principles.
4040
2. After some community discussion, create a PR with the actual change on
41-
[GitHub](https://github.com/bemanproject/beman) and apply the **Beman leads** label.
41+
[GitHub](https://github.com/bemanproject/beman) and apply the *Beman leads* label.
4242
The PR should also link to the discourse topic.
4343
3. Continue discussions on the PR and discourse topic.
4444
4. Await a leads decision based on the community feedback.
@@ -68,7 +68,6 @@ recommendations.
6868

6969
1. [Apache License v2.0 with LLVM Exceptions](https://llvm.org/LICENSE.txt)
7070
2. [Boost Software License 1.0](https://www.boost.org/LICENSE_1_0.txt)
71-
3. [The MIT License](https://opensource.org/license/mit)
7271

7372
### **[license.apache_llvm]**
7473

@@ -131,19 +130,18 @@ Here is snapshot of `default branch` settings in `exemplar` repository:
131130
**Requirement**: There must be a default `Rulesets` configured for any Beman repository (library, infrastructre, documentation, etc.)
132131

133132
Use the following example:
134-
135-
- Go to your repository's settings - e.g., [exemplar/settings](https://github.com/bemanproject/exemplar/settings/).
136-
- Go to `Code and automation` / `Rules` / `Rulesets` - e.g., [exemplar/settings/rulesets](https://github.com/bemanproject/exemplar/settings/rules/).
137-
- You should have a single ruleset named `Default` - e.g., [exemplar/settings/rulesets/beman](https://github.com/bemanproject/exemplar/settings/rulesets/beman).
138-
- Create (via `New ruleset` button) or update (click on `Default` ruleset) it to include the following rules:
139-
- Rulset Name: `Default`
140-
- Enforcement status: `Active`
141-
- Bypass list: Check `Organization admin` and `Repository admin`
142-
- Target branch: Check `Include default branch`
143-
- Go to `Rules` section
144-
- Check `Restrict deletions` and `Block force pushes`
145-
- Check `Require a pull request before merging` and configure it to have `Required approvals: 1`, `Require review from Code Owners` and `Allowed merge methods: Merge, Squash, Rebase`.
146-
- Click `Create` to save the ruleset.
133+
* Go to your repository's settings - e.g., [exemplar/settings](https://github.com/bemanproject/exemplar/settings/).
134+
* Go to `Code and automation` / `Rules` / `Rulesets` - e.g., [exemplar/settings/rulesets](https://github.com/bemanproject/exemplar/settings/rules/).
135+
* You should have a single ruleset named `Default` - e.g., [exemplar/settings/rulesets/beman](https://github.com/bemanproject/exemplar/settings/rulesets/beman).
136+
* Create (via `New ruleset` button) or update (click on `Default` ruleset) it to include the following rules:
137+
* Rulset Name: `Default`
138+
* Enforcement status: `Active`
139+
* Bypass list: Check `Organization admin` and `Repository admin`
140+
* Target branch: Check `Include default branch`
141+
* Go to `Rules` section
142+
* Check `Restrict deletions` and `Block force pushes`
143+
* Check `Require a pull request before merging` and configure it to have `Required approvals: 1`, `Require review from Code Owners` and `Allowed merge methods: Merge, Squash, Rebase`.
144+
* Click `Create` to save the ruleset.
147145

148146
Here is a snapshot of `default branch` settings in `exemplar`:
149147

@@ -154,8 +152,7 @@ Here is a snapshot of `default branch` settings in `exemplar`:
154152
**Recommendation**: The repository should not use git submodules. Check `cmake.use_find_package` for alternatives.
155153

156154
Known exceptions:
157-
158-
- [mpark/wg21: Framework for Writing C++ Committee Papers](https://github.com/mpark/wg21): A non-C++ submodule designed for drafting ISO C++ papers using LaTeX or Markdown.
155+
* [mpark/wg21: Framework for Writing C++ Committee Papers](https://github.com/mpark/wg21): A non-C++ submodule designed for drafting ISO C++ papers using LaTeX or Markdown.
159156

160157
## Release
161158

@@ -182,11 +179,11 @@ Known exceptions:
182179
- Build system changes
183180
- Documentation updates
184181

185-
2.4. A "New Contributors" section listing all first-time contributors.
182+
2.4. A "New Contributors" section listing all first-time contributors.
186183

187-
2.5. A "Full Changelog" link to the complete list of commits.
184+
2.5. A "Full Changelog" link to the complete list of commits.
188185

189-
2.6. A "Contributors" section listing all contributors to this release. Note: This section is autogenerated by GitHub Releases!
186+
2.6. A "Contributors" section listing all contributors to this release. Note: This section is autogenerated by GitHub Releases!
190187

191188
Use the following format:
192189

@@ -201,21 +198,23 @@ Use the following format:
201198

202199
This release has a status of [Under development and not yet ready for production use.](https://github.com/bemanproject/beman/blob/main/docs/beman_library_maturity_model.md#under-development-and-not-yet-ready-for-production-use).
203200

201+
204202
## Changelog
205203

206204
<!-- TODO: Update this section and remove this comment. -->
207205

208-
- <description change> by @${USER} in https://github.com/bemanproject/${REPO}/pull/${PR_ID}
209-
- ...
206+
* <description change> by @${USER} in https://github.com/bemanproject/${REPO}/pull/${PR_ID}
207+
* ...
210208

211209
**Full Changelog**: https://github.com/bemanproject/${REPO}/compare/${PREV_VERSION}...${CURRENT_VERSION}
212210

213211
## New Contributors
214212

215213
<!-- TODO: Update this section and remove this comment. -->
216214

217-
- @${USER} made their first contribution in https://github.com/bemanproject/${REPO}/pull/#${PR_ID}
218-
- ...
215+
* @${USER} made their first contribution in https://github.com/bemanproject/${REPO}/pull/#${PR_ID}
216+
* ...
217+
219218
```
220219

221220
Complete examples can be found in [https://github.com/bemanproject/exemplar/releases](https://github.com/bemanproject/exemplar/releases).
@@ -224,10 +223,12 @@ Here is a snapshot of notes for a particular release in `exemplar`:
224223

225224
![](./images/release.notes-example01.png)
226225

226+
227227
### **[release.godbolt_trunk_version]**
228228

229229
**Recommendation**: A Beman library should have at least a trunk version deployed on godbolt with nightyclone mode activated. Check [tutorial: Compiler Explorer Deployment](https://github.com/bemanproject/beman/blob/main/guidelines/compiler-explorer-deployment.md).
230230

231+
231232
## Top-level
232233

233234
The top-level of a Beman library repository must consist of `CMakeLists.txt`, `LICENSE`, and `README.md` files.
@@ -267,7 +268,6 @@ Examples:
267268
**Requirement**: Following the title, the `README.md` must have a one-line badge list. Examples: library status (`[readme.library_status]`), CI status, code coverage, Compiler Explorer example.
268269

269270
Example:
270-
271271
```markdown
272272
![Library Status](https://raw.githubusercontent.com/bemanproject/beman/refs/heads/main/images/badges/beman_badge-beman_library_under_development.svg) ![Continuous Integration Tests](https://github.com/bemanproject/exemplar/actions/workflows/ci_tests.yml/badge.svg) ![Lint Check (pre-commit)](https://github.com/bemanproject/exemplar/actions/workflows/pre-commit.yml/badge.svg) [![Compiler Explorer Example](https://img.shields.io/badge/Try%20it%20on%20Compiler%20Explorer-grey?logo=compilerexplorer&logoColor=67c52a)](https://godbolt.org)
273273
```
@@ -325,7 +325,7 @@ If the library has been deployed onto Compiler Explorer, add this badge and repl
325325

326326
```markdown
327327
**Implements**: [`std::optional<T&>` (P2988R5)](https://wg21.link/P2988R5) and
328-
[Give **std::optional** Range Support (P3168R1)](https://wg21.link/P3168R1).
328+
[Give *std::optional* Range Support (P3168R1)](https://wg21.link/P3168R1).
329329
```
330330

331331
Note that specifying the revision number is optional.
@@ -363,7 +363,6 @@ or
363363
**Requirement**: Following the library status line and a new line, the `README.md` must have a `LICENSE` section.
364364

365365
Use exactly the following format:
366-
367366
```markdown
368367
## License
369368

@@ -420,6 +419,7 @@ find_package(<PackageName> [REQUIRED])
420419

421420
See `[cmake.skip_tests]` in this document for a working example or [exemplar/blob/main/CMakeLists.txt](https://github.com/bemanproject/exemplar/blob/main/CMakeLists.txt).
422421

422+
423423
### **[cmake.project_name]**
424424

425425
**Recommendation**: The CMake project name should be identical to the beman library name.
@@ -521,6 +521,7 @@ endif()
521521
The `CMakeLists.txt` in the test directory can declare any test-only dependendencies
522522
that are required. For instance:
523523

524+
524525
```CMake
525526
# File: <repo>/tests/CMakeLists.txt
526527
# ...
@@ -581,7 +582,7 @@ add_subdirectory(beman) # Don't do this
581582
add_subdirectory(optional) # Don't do this
582583
```
583584

584-
### **[cmake.implicit_defaults]**
585+
### **[cmake.implicit_defaults]**
585586

586587
**Recommendation**: Where CMake commands have reasonable default values, and the project does not intend to change those values, the parameters should be left implicitly defaulted rather than enumerated in the command.
587588

@@ -798,19 +799,19 @@ first possible line in all files which can contain a comment
798799

799800
Examples:
800801

801-
- C++ files shall use the following form:
802+
* C++ files shall use the following form:
802803

803804
```C++
804805
// SPDX-License-Identifier: <SPDX License Expression>
805806
```
806807

807-
- CMake files and scripts shall use the following form:
808+
* CMake files and scripts shall use the following form:
808809

809810
```CMake
810811
# SPDX-License-Identifier: <SPDX License Expression>
811812
```
812813

813-
- Markdown files will use a comment following the title:
814+
* Markdown files will use a comment following the title:
814815

815816
```markdown
816817
# Title

0 commit comments

Comments
 (0)