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.

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

Use of MUST / MUST NOT / SHOULD / SHOULD NOT / ... #99

Closed
LaurentAjdnik opened this issue Dec 4, 2024 · 2 comments · Fixed by #103
Closed

Use of MUST / MUST NOT / SHOULD / SHOULD NOT / ... #99

LaurentAjdnik opened this issue Dec 4, 2024 · 2 comments · Fixed by #103
Labels
enhancement New feature or request

Comments

@LaurentAjdnik
Copy link
Contributor

These key words are used in many places.

According to BCP14, it is recommended to incorporate this phrase near the beginning of any specification that uses them:

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

PS: Yes, I do agree to PR if needed. 😁

@LaurentAjdnik LaurentAjdnik added the enhancement New feature or request label Dec 4, 2024
@jspahrsummers
Copy link
Member

Thanks, agreed! We'd be happy to review a PR. 🙏

@LaurentAjdnik
Copy link
Contributor Author

PR #103 sent.

Final text taken from RFC8174, which updated RFC2119:

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants