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.
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
Docs: Update so issues are not required (fixes #7015) #7072
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,29 @@ | ||
<!-- | ||
Thanks for submitting a pull request to ESLint. Before continuing, please be sure you've read over our guidelines: | ||
http://eslint.org/docs/developer-guide/contributing/pull-requests | ||
**What is the purpose of this pull request? (put an "X" next to item)** | ||
|
||
Specifically, all pull requests containing code require an **accepted** issue (documentation-only pull requests do not require an issue). If this pull request contains code and there isn't yet an issue explaining why you're submitting this pull request, please stop and open a new issue first. | ||
``` | ||
[ ] Documentation update | ||
[ ] Bug fix ([template](https://github.com/eslint/eslint/blob/master/templates/bug-report.md)) | ||
[ ] New rule ([template](https://github.com/eslint/eslint/blob/master/templates/rule-proposal.md)) | ||
[ ] Changes an existing rule ([template](https://github.com/eslint/eslint/blob/master/templates/rule-change-proposal.md)) | ||
[ ] Add autofixing to a rule | ||
[ ] Add a CLI option | ||
[ ] Add something to the core | ||
[ ] Other, please explain: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If you want, you could also use GitHub's checkbox list feature. That would mean no code fence and each line is preceded with an unordered list token ( EDIT: You're using that further down, so I assume this was an intention choice. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, this was intentional. Otherwise, people can change it from the issue directly, and that's not what we want here. |
||
``` | ||
|
||
Please answer all questions below. | ||
--> | ||
*If the item you've check above has a template, please paste the template questions here and answer them.* | ||
|
||
**What issue does this pull request address?** | ||
|
||
|
||
**Please check each item to ensure your pull request is ready:** | ||
|
||
- [ ] I've read the [pull request guide](http://eslint.org/docs/developer-guide/contributing/pull-requests) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we want to phrase this as a list of checkboxes? This feels a lot like "Yes, I've read terms and conditions" callouts. Maybe we should just mention that to make successful pull request you should do the following things? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd rather force them to check the boxes. People can easily skip over reading text, but actions are harder to skip. |
||
- [ ] I've included tests for my change | ||
- [ ] I've updated documentation for my change (if appropriate) | ||
|
||
**What changes did you make? (Give an overview)** | ||
|
||
|
||
**Is there anything you'd like reviewers to focus on?** | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
**Tell us about your environment** | ||
|
||
* **ESLint Version:** | ||
* **Node Version:** | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same as issue template. |
||
* **npm Version:** | ||
|
||
**What parser (default, Babel-ESLint, etc.) are you using?** | ||
|
||
**Please show your full configuration:** | ||
|
||
**What did you do? Please include the actual source code causing the issue.** | ||
|
||
**What did you expect to happen?** | ||
|
||
**What actually happened? Please include the actual, raw output from ESLint.** | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
**What rule do you want to change?** | ||
|
||
|
||
**Does this change cause the rule to produce more or fewer warnings?** | ||
|
||
|
||
**How will the change be implemented? (New option, new default behavior, etc.)?** | ||
|
||
|
||
**Please provide some example code that this change will affect:** | ||
|
||
```js | ||
<!-- example code here --> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should this be a js comment syntax instead, since it's inside a "```js" code block? /* example code here */ There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No. The html comment won't be output of its left in by mistake, a JS comment will |
||
``` | ||
|
||
**What does the rule currently do for this code?** | ||
|
||
|
||
**What will the rule do after it's changed?** |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
**Please describe what the rule should do:** | ||
|
||
|
||
**What category of rule is this? (place an "X" next to just one item)** | ||
|
||
``` | ||
[ ] Enforces code style | ||
[ ] Warns about a potential error | ||
[ ] Suggests an alternate way of doing something | ||
[ ] Other (please specify:) | ||
``` | ||
|
||
**Provide 2-3 code examples that this rule will warn about:** | ||
|
||
```js | ||
<!-- put your code examples here --> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same for this one here! |
||
``` | ||
|
||
**Why should this rule be included in ESLint (instead of a plugin)?** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.