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.

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

github: add troubleshooting steps to the issue template #350

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 32 additions & 5 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,38 @@
#### What happens and why it is wrong

#### Environment
## Troubleshooting
<!--
Please follow the steps below to ensure that you have troubleshot this problem sufficiently to believe that it is a bug in this plugin.
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.
-->

<!--- describe your environment if it is relevant to the problem --->
1. Does `tsc` have the same output? If so, please explain why this is incorrect behavior
<!--
This plugin uses the TS LanguageService under-the-hood.
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.
There are cases where they should differ, however, so if this is one of those, please elaborate.
-->

1. Does your Rollup plugin order match [this plugin's compatibility](https://github.com/ezolenko/rollup-plugin-typescript2#compatibility)? If not, please elaborate
<!--
Rollup plugin order matters, so if there is a mismatch here, that could be the cause of your issue.
-->

1. Can you create a [minimal example](https://stackoverflow.com/help/minimal-reproducible-example) that reproduces this behavior?
<!--
Minimal reproductions help us find the root cause of an issue much more expediently than trying to interpret and disentangle a complicated repo.
The process of creating a minimal reproduction also often helps users find a misconfiguration in their code.
It could also help you identify the root cause yourself and potentially create a Pull Request to fix it!
-->

## What happens and why it is incorrect
<!--
Please explain the issue you are encountering and why you believe it is incorrect behavior, in detail.
Please list any error messages here.
-->

##### Versions
## Environment
<!-- Please describe your environment, especially anything potentially relevant to the problem -->

### Versions
<!--
PLEASE RUN THIS COMMAND INSIDE YOUR PROJECT:

Expand Down
13 changes: 7 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,16 @@

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

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.
Please follow the issue template as closely as possible:

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

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

If it makes sense, check if running `tsc` directly produces similar results.

Attach plugin output with `verbosity` option set to 3 (this will list all files being transpiled and their imports).
- Attach plugin output with `verbosity` option set to `3` (this will list all files being transpiled and their imports).
- If it makes sense, check if running `tsc` directly produces similar results.
- Check if you get the same problem with `clean` option set to `true` (might indicate a bug in the cache).
- 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).

## Developing

Expand Down