Docs: Update so issues are not required (fixes #7015) #7072
Conversation
|
@nzakas, thanks for your PR! By analyzing the annotation information on this pull request, we identified @Mardak, @mikesherov and @mysticatea to be potential reviewers |
|
LGTM |
| @@ -71,7 +70,7 @@ The `Tag` is one of the following: | |||
|
|
|||
| Use the [labels of the issue you are working on](working-on-issues#issue-labels) to determine the best tag. | |||
|
|
|||
| The message summary should be a one-sentence description of the change, and it must be 72 characters in length or shorter. The issue number should be mentioned at the end. If the commit doesn't completely fix the issue, then use `(refs #1234)` instead of `(fixes #1234)`. | |||
| The message summary should be a one-sentence description of the change, and it must be 72 characters in length or shorter. If the pull request addresses an issue, the the issue number should be mentioned at the end. If the commit doesn't completely fix the issue, then use `(refs #1234)` instead of `(fixes #1234)`. | |||
|
LGTM aside from the suggestions already mentioned |
|
LGTM |
|
|
||
| * **ESLint Version:** | ||
| * **Node Version:** | ||
| * **npm Version:** |
There was a problem hiding this comment.
Do we really need Node version and NPM version? We are sometimes very strict about requiring all of the fields in the template be filled out, and those two might make a difference, but only very occasionally. For most bugs they don't really matter.
There was a problem hiding this comment.
I don't see a downside to asking for this info. The fewer times we need to ask for more info, the faster triage goes.
There was a problem hiding this comment.
The downside is higher bar of entry. If we ask for it in the template but don't insist on people providing that information if they skipped it, I'm fine with it. But requiring 100% of people to provide it when it might only be relevant in 2% of cases is an overkill.
|
Okay, going to merge this. As always, we can see how this works in reality and make incremental changes to address any problems we find. |
eslint-deprecated
bot
added
the
archived due to age
What issue does this pull request address?
#7015
What changes did you make? (Give an overview)
Is there anything you'd like reviewers to focus on?
What do you think about the various templates? I tried to balance the need for getting important information into the pull request with not overwhelming people.