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

Docs: Add more fields to bug report template #14039

Merged
merged 1 commit into from Feb 9, 2021
Merged

Docs: Add more fields to bug report template #14039

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 12 additions & 2 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
View file
Open in desktop
Expand Up @@ -16,7 +16,7 @@ assignees: ''
1. To propose a new rule: https://eslint.org/docs/developer-guide/contributing/new-rules
2. To request a rule change: https://eslint.org/docs/developer-guide/contributing/rule-changes
3. To request a change that is not a bug fix, rule change, or new rule: https://eslint.org/docs/developer-guide/contributing/changes
4. If you have any questions, please stop by our chatroom: https://eslint.org/chat
4. If you have any questions, please stop by our chatroom: https://eslint.org/chat/help

Note that leaving sections blank will make it difficult for us to troubleshoot and we may have to close the issue.
-->
Expand All @@ -31,6 +31,7 @@ assignees: ''
* **ESLint Version:**
* **Node Version:**
* **npm Version:**
* **Operating System:**
Copy link
Member

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.

Copy link
Member Author

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. :)


**What parser (default, `@babel/eslint-parser`, `@typescript-eslint/parser`, etc.) are you using?**

Expand Down Expand Up @@ -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.**
Copy link
Member

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.
Comment on lines +68 to +74
Copy link
Member

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?

Copy link
Member Author

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.

Copy link
Member

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?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Type this code into editor “”
  2. Configure rule with these options
  3. Run ESLint
  4. 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.

Copy link
Member

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.

Copy link
Member Author

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed!


**Are you willing to submit a pull request to fix this bug?**