Skip to content

Commit 02d838b

Browse files
authored
Update the README's description of entries (#265)
* Add missing categories * Update some naming I intentionally did not make the list layout match the YAML because this way seems more useful to a reader trying to understand the general concept. Signed-off-by: Ben Cotton <[email protected]>
1 parent c4946f7 commit 02d838b

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

Diff for: README.md

+12-9
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,24 @@ Each entry has the following values:
1616
- Level 1: for any code or non-code project with any number of maintainers or users
1717
- Level 2: for any code project that has at least 2 maintainers and a small number of consistent users
1818
- Level 3: for any code project that has a large number of consistent users
19-
- **Category**:
20-
- Access Control
21-
- Build & Release
22-
- Documentation
23-
- Quality
24-
- Legal
25-
- **Control**:
19+
- **Family** (see corresponding yaml files for descriptions):
20+
- [Access Control](baseline/OSPS-AC.yaml)
21+
- [Build & Release](baseline/OSPS-BR.yaml)
22+
- [Documentation](baseline/OSPS-DO.yaml)
23+
- [Governance](baseline/OSPS-GV.yaml)
24+
- [Legal](baseline/OSPS-LE.yaml)
25+
- [Quality](baseline/OSPS-QA.yaml)
26+
- [Security Assessment](baseline/OSPS-SA.yaml)
27+
- [Vulnerability Management](baseline/OSPS-VM.yaml)
28+
- **Title**:
2629
- A concise statement of the requirement
2730
- Contains `MUST` or `MUST NOT` and is written in present tense
2831
- The term before MUST/NOT is the _subject_ of the requirement
2932
- Terms following MUST/NOT describe the _required behavior_
30-
- **Rationale**:
33+
- **Objective**:
3134
- A concise statement of the goal of the requirement
3235
- Written in present tense and describes the desired outcome
33-
- **Details**:
36+
- **Assessment requirement(s)**:
3437
- A concise description of how to meet the requirement
3538
- Written in present tense and describes the steps to take to meet the requirement
3639
- May outline recommendations, examples, or best practices

0 commit comments

Comments
 (0)