mediamonks / frontend-coding-standards

Media.Monks - Frontend Coding Standards
60 stars 23 forks source link

Key words to Indicate Requirement Levels #56

Open psimk opened 3 years ago

psimk commented 3 years ago

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,

ThaNarie commented 3 years ago

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 commented 3 years ago

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