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

Jump to bottom

Proposal: Consistent use of "must" and "should" #2036

Closed
sharwell opened this issue Jan 11, 2016 · 4 comments
Closed

Proposal: Consistent use of "must" and "should" #2036

sharwell opened this issue Jan 11, 2016 · 4 comments
Assignees
@sharwell
Labels
enhancement fixed
Milestone
1.1.0 Beta 4

Comments

@sharwell
Copy link
Member

I propose updating the titles, messages, and descriptions of all rules to be consistent with the following:

Default severity Wording
Hidden/Info May
Warning Should
Error Must
@sharwell sharwell added this to the 1.1.0 milestone Jan 11, 2016
@vweijsters
Copy link
Contributor

👍 But we will be needing clear guidelines on when a diagnostic will be marked as error.

@sharwell
Copy link
Member Author

when a diagnostic will be marked as error.

No diagnostics are currently or planned to be marked as error.

@vweijsters
Copy link
Contributor

That definitely is a clear guideline 😄

@GregReddick
Copy link

The standard for May, Should, Must comes from RFC 2119 (https://tools.ietf.org/html/rfc2119). We should consider updating the documentation of rules to use RFC 2119 consistently.

sharwell added a commit to sharwell/StyleCopAnalyzers that referenced this issue Jun 22, 2017
@sharwell
Update wording to reflect rule severity
caa7453 
Fixes DotNetAnalyzers#2036
Fixes DotNetAnalyzers#2272
@sharwell sharwell removed the proposal label Jun 22, 2017
@sharwell sharwell self-assigned this Jun 22, 2017
@sharwell sharwell modified the milestones: 1.1.0 Beta 4, 1.1.0 Jun 22, 2017
@sharwell sharwell mentioned this issue Jun 22, 2017
Merged
sharwell added a commit to sharwell/StyleCopAnalyzers that referenced this issue Jun 22, 2017
@sharwell
Update wording to reflect rule severity
0878d9b 
Fixes DotNetAnalyzers#2036
Fixes DotNetAnalyzers#2272
@sharwell sharwell added the fixed label Jun 22, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sharwell sharwell

Labels
enhancement fixed
Projects
None yet
Milestone
1.1.0 Beta 4
Development

No branches or pull requests
3 participants
@sharwell @GregReddick @vweijsters