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

Key words to Indicate Requirement Levels #56

Open
psimk opened this issue Feb 5, 2021 · 2 comments
Open

Key words to Indicate Requirement Levels #56

psimk opened this issue Feb 5, 2021 · 2 comments

Comments

@psimk
Copy link

psimk commented Feb 5, 2021

I think that we should enforce using RFC 2119 in the standards. As this will give the reader a better understanding on how important a certain guideline is.

Moreover, as the next step, we should add a chapter about this and enforce this in code comments, documentation and discussions. As the same point is true - everyone gets a better understanding on the importance of something.

Example:
I should create an issue vs I must create an issue give off different levels of importance,

  • should is like a suggestion and the importance isn't high and that this may or may not happen,
  • must shows the intention that something has to happen.
@ThaNarie
Copy link
Member

ThaNarie commented Feb 5, 2021

should is like a suggestion

Should is more than a suggestion, it's a recommendation, which "should" be followed unless there are specific reasons not to.

and that this may or may not happen

That's where the may is for :) Just a suggestion.

Otherwise I'll agree that it adds clarity.

@psimk
Copy link
Author

psimk commented Feb 8, 2021

I paraphrased recommendation to suggestion, but now I see that it just solidifies the initial point that word should be used with a clear intention :)

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

No branches or pull requests

2 participants