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: Add more fields to bug report template #14039
Conversation
@@ -31,6 +31,7 @@ assignees: '' | |||
* **ESLint Version:** | |||
* **Node Version:** | |||
* **npm Version:** | |||
* **Operating System:** |
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.
currently, running eslint --env-info
does not print the OS; but it seems good to have.
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’m assuming people know what operating system they are using. :)
@@ -61,7 +62,16 @@ assignees: '' | |||
**What did you expect to happen?** | |||
|
|||
|
|||
**What actually happened? Please include the actual, raw output from ESLint.** | |||
**What actually happened? Please copy-paste the actual, raw output from ESLint.** |
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.
👍
**Steps to reproduce this issue:** | ||
|
||
<!-- Please tell us exactly how to see the issue you're describing --> | ||
|
||
1. | ||
1. | ||
1. |
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.
This is sometimes useful, but I think far more often redundant with other fields. Can we instead ask for the exact steps only when we are unable to reproduce the issue?
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’d rather a bit of redundancy upfront. When I’m looking at bugs, too often people leave out repro steps and not enough people ask. Let’s just get it out of the way early.
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'm not seeing many issues where additional info is needed, aside from those where people don't fill out the existing sections or completely ignore the template.
What would be repro steps for a bug report related to a rule?
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.
- Type this code into editor “”
- Configure rule with these options
- Run ESLint
- See unexpected rule result
Can you explain your concern over adding this? To me, I’d just like KOR info upfront as I don’t feel like we always get the best bug reports. Especially if we are going to start letting non-team members so triage, I think having this info will really help.
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.
Can you explain your concern over adding this?
Only that a template with many fields might be discouraging for users who'd like to report a bug.
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 can understand that. My feeling is that this additional ask isn’t enough to dissuade people from filing an issue.
can we try this and see what happens? We can always remove it if it’s a problem, but I think this is important to include to help out the triage team, who may not be as familiar with ESLint internals.
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.
Agreed!
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Add a few more fields to the bug report template: one for operating system (since that is sometimes the issue) and asking for explicit reproduction steps. I also updated the chat link to point directly to the help channel and clarified that we want people to copy-paste the actual ESLint output (since people seem not to do that).
Is there anything you'd like reviewers to focus on?
Do these changes make sense?