Skip to content

Commit 8b82a58

Browse files
sappelhoffeffigies
andauthored
[ENH] clarify guiding principles for requirement levels (#1444)
* [ENH] clarify guiding principles for requirement levels * remove backticks, add metadata Co-authored-by: Chris Markiewicz <[email protected]> --------- Co-authored-by: Chris Markiewicz <[email protected]>
1 parent 2f94687 commit 8b82a58

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

src/common-principles.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,17 @@ The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
66
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
77
interpreted as described in [[RFC2119](https://www.ietf.org/rfc/rfc2119.txt)].
88

9-
Throughout this specification we use a list of terms and abbreviations. To avoid
10-
misunderstanding we clarify them here.
9+
Based on these keywords, we define three requirement levels for specifying data or metadata:
10+
REQUIRED, RECOMMENDED, and OPTIONAL.
11+
The guiding principles for when particular data is placed under a given requirement level
12+
can be loosely described as below:
13+
14+
* REQUIRED: Data cannot be be interpreted without this information (or the ambiguity is unacceptably high)
15+
* RECOMMENDED: Interpretation/utility would be dramatically improved with this information
16+
* OPTIONAL: Users and/or tools might find it useful to have this information
17+
18+
Throughout this specification we use a list of terms and abbreviations.
19+
To avoid misunderstanding we clarify them here.
1120

1221
<!-- This block generates a file tree.
1322
A guide for using macros can be found at

0 commit comments

Comments
 (0)