Readme: Add ISSUE_TEMPLATE with issue guidelines to repository #1104
Conversation
Overall I think this is a great idea, some suggestions for tweaks though
.github/ISSUE_TEMPLATE.md
Outdated
|
|
||
| ## Tell us about your runtime: | ||
|
|
||
| * **OS**: |
There was a problem hiding this comment.
I think we should leave this out to minimize friction. We rarely ever get cases where the OS influences behavior.
.github/ISSUE_TEMPLATE.md
Outdated
|
|
||
| * **OS**: | ||
| * **QUnit version**: | ||
| * **How are you running QUnit? (e.g., browser, Grunt)**: |
There was a problem hiding this comment.
I think this may potentially conflate two separate questions/pieces of information:
- What environment are you running QUnit in? (e.g., browser, node)
- How are you running QUnit? (e.g., testem, grunt, script, etc.)
|
|
||
| ## What are you trying to do? | ||
|
|
||
| Code that reproduces the problem: |
There was a problem hiding this comment.
We should likely add a comment to the effect of "Please provide an exact reproduction of your issue if possible. If not, then please provide detailed information about your setup and what you are trying to do."
This is because sometimes developers can't share the actual code (e.g., when working on private projects) and may not have time to get a minimal reproduction setup before filing the issue.
|
@trentmwillis Thanks, I've updated per your suggestions. Let me know if other improvements are needed. |
|
Ping @qunitjs/qunit-team, how does this look now? Anything else I can do to improve this? |
|
One more friendly ping to @qunitjs/qunit-team, anything else I need to change or can this be merged? |
|
I seems fine to me. I'm sorry for the brevity in my answer. I really like to have these templates in here. |
|
@leobalter No problem, thanks for commenting. |
|
Thanks @trentmwillis and @leobalter! |
I thought it might be a good idea to take advantage of GitHub's support for issue templates to try to ensure we get useful issue reports.
I wrote this template very quickly and it probably could use serious copy editing. Please feel free to either make suggestions here or just push directly to my branch to help improve this. Or, if we don't think we'll get value out of this, feel free to close this PR.