Skip to content

Commit a73e34e

Browse files
authored
github: add troubleshooting steps to the issue template (#350)
- these steps should help in 2 ways: 1. hopefully avoid common misconfigurations from being repeatedly opened as bug reports - some of these have labels on them now to get a sense of how often they pop up 2. help contributors and maintainers diagnose issues quicker and figure out if an issue is indeed a bug - the diagnosis questions are really common things we ask in an issue already, so think it would work out better to get that up-front - we have labels for some of these too - especially as issues can often get no response / go stale, and if it's truly a bug, it's better to know that earlier than later - condense the `CONTRIBUTING.md` a bit now that some of the most common debugging steps are in the issue template - didn't put in `npm prune` or `clean: true` _yet_, as don't want to make the issue template _too_ big overnight - those also aren't as common an issue and people seem to figure out that an issue is due to caching bugs pretty often already - probably want to move to GitHub's new beta Issue Forms moving forward, but thought it'd be best to get the details into Markdown first, _then_ can migrate - and also creating Issue Forms seems to require moving to the multiple Issue Templates format where users select a "type" of issue (e.g. bug report vs. feature request etc), but we don't have multiple templates yet, so that could be confusing
1 parent d32cf83 commit a73e34e

File tree

2 files changed

+39
-11
lines changed

2 files changed

+39
-11
lines changed

.github/issue_template.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,38 @@
1-
#### What happens and why it is wrong
2-
3-
#### Environment
1+
## Troubleshooting
2+
<!--
3+
Please follow the steps below to ensure that you have troubleshot this problem sufficiently to believe that it is a bug in this plugin.
4+
Many issues are the result of common misconfigurations and are not bugs, so please follow the steps to help us help you and prioritize limited volunteer maintainer time.
5+
-->
46

5-
<!--- describe your environment if it is relevant to the problem --->
7+
1. Does `tsc` have the same output? If so, please explain why this is incorrect behavior
8+
<!--
9+
This plugin uses the TS LanguageService under-the-hood.
10+
It tries to mimic tsc and add Rollup semantics where possible, so if tsc has the same output, the error you're getting may be correct and accurate.
11+
There are cases where they should differ, however, so if this is one of those, please elaborate.
12+
-->
13+
14+
1. Does your Rollup plugin order match [this plugin's compatibility](https://github.com/ezolenko/rollup-plugin-typescript2#compatibility)? If not, please elaborate
15+
<!--
16+
Rollup plugin order matters, so if there is a mismatch here, that could be the cause of your issue.
17+
-->
18+
19+
1. Can you create a [minimal example](https://stackoverflow.com/help/minimal-reproducible-example) that reproduces this behavior?
20+
<!--
21+
Minimal reproductions help us find the root cause of an issue much more expediently than trying to interpret and disentangle a complicated repo.
22+
The process of creating a minimal reproduction also often helps users find a misconfiguration in their code.
23+
It could also help you identify the root cause yourself and potentially create a Pull Request to fix it!
24+
-->
25+
26+
## What happens and why it is incorrect
27+
<!--
28+
Please explain the issue you are encountering and why you believe it is incorrect behavior, in detail.
29+
Please list any error messages here.
30+
-->
631

7-
##### Versions
32+
## Environment
33+
<!-- Please describe your environment, especially anything potentially relevant to the problem -->
834

35+
### Versions
936
<!--
1037
PLEASE RUN THIS COMMAND INSIDE YOUR PROJECT:
1138

CONTRIBUTING.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,16 @@
44

55
Report any bugs [in the GitHub Issue Tracker](https://github.com/ezolenko/rollup-plugin-typescript2/issues).
66

7-
Attach your `tsconfig.json`, `package.json` (for versions of dependencies), `rollup.config.js`, and anything else that could influence module resolution, ambient types, and TS compilation.
7+
Please follow the issue template as closely as possible:
88

9-
Check if the problem is reproducible after running `npm prune` to clear any rogue types from `node_modules` (by default TS grabs _all_ ambient types).
9+
- Attach your `tsconfig.json`, `package.json` (for versions of dependencies), `rollup.config.js`, and any other pieces of your environment that could influence module resolution, ambient types, and TS compilation.
1010

11-
Check if you get the same problem with `clean` option set to `true` (might indicate a bug in the cache).
11+
Some additional debugging steps you can take to help diagnose the issue:
1212

13-
If it makes sense, check if running `tsc` directly produces similar results.
14-
15-
Attach plugin output with `verbosity` option set to 3 (this will list all files being transpiled and their imports).
13+
- Attach plugin output with `verbosity` option set to `3` (this will list all files being transpiled and their imports).
14+
- If it makes sense, check if running `tsc` directly produces similar results.
15+
- Check if you get the same problem with `clean` option set to `true` (might indicate a bug in the cache).
16+
- Check if the problem is reproducible after running `npm prune` to clear any rogue types from `node_modules` (by default TS grabs _all_ ambient types).
1617

1718
## Developing
1819

0 commit comments

Comments
 (0)