chore: update issue templates #2397
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I didn't want to add another comment to the template, as there's already enough that I don't think people read anyways. So I've added a simple checklist to every template. A few common problems people have when filing issues: 1) people don't ever restart their IDE. Often times they've done git rebases, yarn installs/removals, added and deleted folders, and just generally caused things to get into a weird state. Restarting the IDE almost always fixes the issue. 2) people are running an old version of the package. In some cases people have filed issues using a 3+ month old versions of the tooling. Updating ensures that they have all the latest fixes. 3) people haven't read the FAQ. I've tried to keep it up-to-date with concise and helpful information, but some people just don't read it. So it's a hard link to force them to check it. 4) people file issues against `eslint-plugin-tslint` or `parser` when they meant to file it against `eslint-plugin`. I can _sort of_ understand this, because there are a lot of packages. So I've added a big ***STOP*** section to every template to help point people to the right template. 5) Issues are not reproducible due to it being a user config error. There have been a decent number of issues that just weren't reproducible based on the issue filed. When asked to create a repro repo, the issue reporters were either unable to create an isolated repro, or they figured out their bad config when creating the isolated repro. This one is hard, because we can't reasonably expect every reporter to create a repro repo for their issue. I've added a one line note, maybe that inspires someone and wards off some noise.
|
Thanks for the PR, @bradzacher! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day. |
Codecov Report
@@ Coverage Diff @@
## master #2397 +/- ##
=======================================
Coverage 93.16% 93.16%
=======================================
Files 286 286
Lines 9161 9161
Branches 2517 2517
=======================================
Hits 8535 8535
Misses 301 301
Partials 325 325
Flags with carried forward coverage won't be shown. Click here to find out more. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I didn't want to add another comment to the template, as there's already enough that I don't think people read anyways.
So I've added a simple checklist to every template (for the first 3).
A few common problems people have when filing issues:
people don't ever restart their IDE.
Often times they've done git rebases, yarn installs/removals, added and deleted folders, and just generally caused things to get into a weird state.
Restarting the IDE almost always fixes the issue.
people are running an old version of the package.
In some cases people have filed issues using a 3+ month old versions of the tooling.
Updating ensures that they have all the latest fixes.
people haven't read the FAQ.
I've tried to keep it up-to-date with concise and helpful information, but some people just don't read it.
So it's a hard link to force them to check it.
people file issues against
eslint-plugin-tslintorparserwhen they meant to file it againsteslint-plugin.I can sort of understand this, because there are a lot of packages.
So I've added a big STOP section to every template to help point people to the right template.
Issues are not reproducible due to it being a user config error.
There have been a decent number of issues that just weren't reproducible based on the issue filed.
When asked to create a repro repo, the issue reporters were either unable to create an isolated repro, or they figured out their bad config when creating the isolated repro.
This one is hard, because we can't reasonably expect every reporter to create a repro repo for their issue.
I've added a one line note, maybe that inspires someone and wards off some noise.