github: add troubleshooting steps to the issue template #350
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.
Summary
Add 3 very common troubleshooting steps to the issue template to help both users and maintainers/contributors
Details
these steps should help in 2 ways:
condense the
CONTRIBUTING.md
a bit now that some of the most common debugging steps are in the issue templatenpm prune
orclean: true
yet, as don't want to make the issue template too big overnightNext Steps
In somewhat of an order:
If needed, in the future we can add the
npm prune
,clean: true
parts of theCONTRIBUTING.md
to the troubleshooting steps. Similarly, we can ask if people have read theCONTRIBUTING.md
as well if needed (in issue forms, that's a common checkbox and is an example in the docs). "Search terms" like the TypeScript repo has could be useful in the future as well and are gaining some traction in repos nowadays too.