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

Update introduction.adoc to use RFC 2119 terminology everywhere #693

Closed
wants to merge 1 commit into from
Closed

Update introduction.adoc to use RFC 2119 terminology everywhere #693

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions chapters/introduction.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,12 @@ work evolves, but teams can confidently follow and trust them.

In case guidelines are changing, following rules apply:

* existing APIs don't have to be changed, but we recommend it
* clients of existing APIs have to cope with these APIs based on
* it is RECOMMENDED that the existing APIs be changed
* clients of existing APIs MUST cope with these APIs based on
outdated rules
* new APIs have to respect the current guidelines
* new APIs MUST respect the current guidelines

Furthermore you should keep in mind that once an API becomes public
externally available, it has to be re-reviewed and changed according to
current guidelines - for sake of overall consistency.
externally available, it MUST be re-reviewed and changed according to
current guidelines - for the sake of overall consistency.
Comment on lines -58 to +65
Copy link
Member

@tkrop tkrop Dec 7, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sdousti Thank you for your contribution and sorry for the late reply.

As much as I like your rewording, the use of capital letter MUST and RECOMMENDED is currently not consistent with our usage in text - only in rule titles. If you change it to lower case bold, we would merge it for. Else we would need to agree on a new style before we can merge your suggestions (see also comment on #660).