Add issue template for a rule change #2279
Conversation
| description: As rule could be improved or extended? | ||
| title: "`rule-name` should do xyz" | ||
| labels: | ||
| - enhacement |
There was a problem hiding this comment.
| - enhacement | |
| - enhancement |
Alternatively, it could use a change request label like we have in Refined GitHub. For example it would better cover stuff like:
There was a problem hiding this comment.
I would go with improvement
There was a problem hiding this comment.
improvement is a synonym of enhancement
The choice would be between "change" and "improve". Technically every change is an improvement, but in this case I'm seeing "change" as I don't agree with this rule, please alter it, like
There was a problem hiding this comment.
Let's go with "change request" then. Doesn't really matter that much.
| @@ -0,0 +1,56 @@ | |||
| name: Rule change | |||
| description: As rule could be improved or extended? | |||
There was a problem hiding this comment.
This sentence doesn't read well to me
There was a problem hiding this comment.
"A rule"
This follows the "Bug report" format
| description: As rule could be improved or extended? | ||
| title: "`rule-name` should do xyz" | ||
| labels: | ||
| - enhacement |
There was a problem hiding this comment.
I would go with improvement
| required: true | ||
| attributes: | ||
| label: Description | ||
| description: Explain here what change or improvement you'd like. |
There was a problem hiding this comment.
| description: Explain here what change or improvement you'd like. | |
| description: Explain the improvement you would like to see. |
| - type: textarea | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: Fail | ||
| description: Specify examples of code that should be detected | ||
| value: | | ||
| ```js | ||
| var replace = 'me'; | ||
| ``` | ||
|
|
||
| ```js | ||
| function foo() { | ||
| var replace = 'me'; | ||
| return replace; | ||
| } | ||
| ``` | ||
| - type: textarea | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: Pass | ||
| description: Specify examples of code that would be accepted in its place | ||
| value: | | ||
| ```js | ||
| const replace = 'me'; | ||
| ``` | ||
|
|
||
| ```js | ||
| function foo() { | ||
| return 'me'; | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Is this really necessary for this type of issue?
There was a problem hiding this comment.
The "good code" isn't needed if the suggestion is:
- "Also detect this other way to do the same thing"
but it's definitely needed if it's:
- "Also autofix this other similar but unrelated method"
It looks like most open issues are to request changes or options to existing rules, so I thought I'd create a template.