frontend-coding-standards icon indicating copy to clipboard operation
frontend-coding-standards copied to clipboard

Key words to Indicate Requirement Levels

Open psimk opened this issue 4 years ago • 2 comments

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.

psimk avatar Feb 05 '21 17:02 psimk

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.

ThaNarie avatar Feb 05 '21 19:02 ThaNarie

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 :)

psimk avatar Feb 08 '21 09:02 psimk