Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[ENH] clarify guiding principles for requirement levels #1444

Merged
merged 2 commits into from
Mar 24, 2023
Merged

[ENH] clarify guiding principles for requirement levels #1444

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7397f5
[ENH] clarify guiding principles for requirement levels
sappelhoff Mar 16, 2023
1c5e9e2
remove backticks, add metadata
sappelhoff Mar 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions src/common-principles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,17 @@ The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
interpreted as described in [[RFC2119](https://www.ietf.org/rfc/rfc2119.txt)].

Throughout this specification we use a list of terms and abbreviations. To avoid
misunderstanding we clarify them here.
Based on these keywords, we define three requirement levels for specifying data:
`REQUIRED`, `RECOMMENDED`, and `OPTIONAL`.
The guiding principles for when particular data is placed under a given requirement level
can be loosely described as below:

* `REQUIRED`: Data cannot be be interpreted without this information (or the ambiguity is unacceptably high)
* `RECOMMENDED`: Interpretation/utility would be dramatically improved with this information
* `OPTIONAL`: Users and/or tools might find it useful to have this information
sappelhoff marked this conversation as resolved.
Show resolved Hide resolved

Throughout this specification we use a list of terms and abbreviations.
To avoid misunderstanding we clarify them here.

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