Keyword capitalization in guideline documents#501
Merged
rartych merged 7 commits intocamaraproject:mainfrom Jul 30, 2025
Merged
Keyword capitalization in guideline documents#501rartych merged 7 commits intocamaraproject:mainfrom
rartych merged 7 commits intocamaraproject:mainfrom
Conversation
Contributor
Author
|
Merge confict reolved |
PedroDiez
previously approved these changes
Jul 28, 2025
Contributor
PedroDiez
left a comment
There was a problem hiding this comment.
Editorial format
LGTM in advance
This was referenced Aug 19, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
What this PR does / why we need it:
Proposed changes try unify the writing of key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL".
When these words are used for formulating requirements , they are capitalized.
Capitalization is not applied to mandatory texts.
In CAMARA API Event Subscription and Notification Guide the introductory sections were added: on this convention and common API requirements.
Some corrections were added to the text.
Which issue(s) this PR fixes:
Fixes #447
Does this PR introduce a breaking change?
Special notes for reviewers:
Changelog input
Additional documentation
This section can be blank.