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: trueyet, 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
Next Steps
In somewhat of an order:
get a repro environment functioning and add it to the issue template repro question
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
write up a small PR template, basically the main sections I use in my PRs like everywhere ("Summary", "Details", and maybe some optional sections like this one)
write up a small feature request template (mentioned in #312)
If needed, in the future we can add the npm prune, clean: true parts of the CONTRIBUTING.md to the troubleshooting steps. Similarly, we can ask if people have read the CONTRIBUTING.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.
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.