Improve the issue template. #787
Conversation
The current issue template uses HTML comment tags to remove template text from the rendered output. I have gone through the last dozen issues filed, and it appears everyone deletes that anyways. By removing the comment tags, people can click "Preview" and get a pretty print of the template markdown. Reformat lists and links. Tries to get links as close to the left edge as possible, so they are easy to see, and copy-paste from the raw markdown editor. Puts multiple links on their own line for the same reason. Adds a request that they explicitly tell us what their AVA and `npm` versions are. Adds a section for their AVA config and CLI args. Adds a section for linking to thier project if public. Requests they create a minimal reproduction and post it to GitHub.
| The versions of AVA and `npm` in use: | ||
|
|
||
| ``` | ||
| ava --version |
There was a problem hiding this comment.
This is not really necessary as we already tell them to reproduce it with the latest version.
There was a problem hiding this comment.
Yes. But getting them to actually state "I'm running version XXX" eliminates one question-answer round. When trying to figure out the problem
There was a problem hiding this comment.
I would include these in the above Environment snippet though.
|
I think the tone could be warmer, so that it feel less like you're going to get yelled at if you missed a step. You guys are all really nice and helpful, but that doesn't convey here :) |
Yeah, I struggled with that. I don't want to add a lot of verbosity getting there though. It's already pretty long, and I don't want to add flowery language that doesn't help them just get on with it. I'm sure there are ways to improve it that would keep it short and sweet though. I'm open to suggestions. |
|
@jfmengels Any specific suggestions would help ;) |
Yeah I know, sorry about the lack of specificity. Will try to come up with stuff later tonight, but it's not my forte either. In the meantime and for reading purposes, there is @benmosher's very nice contributing file import-js/eslint-plugin-import#258. It's not the same topic, but it can be a source of inspiration (which I'll probably re-read before thinking of improving this). |
|
OK, I incorporated the feedback, and tried to make it a little less intimidating with 4edabb9 |
| - Read the [contributing guidelines](https://github.com/sindresorhus/ava/blob/master/contributing.md). | ||
| - Support questions are better asked in our [chat](https://gitter.im/sindresorhus/ava) or on [Stack Overflow](https://stackoverflow.com/questions/tagged/ava). | ||
| - Support questions are better asked in one of the following locations: | ||
| - [Our chat](https://gitter.im/sindresorhus/ava) |
There was a problem hiding this comment.
Link has changed: https://gitter.im/avajs/ava
|
LGTM, except for the Gitter link. Sorry for blocking this :s |
|
|
||
| ## Prerequisites | ||
|
|
||
| - We realize there is a lot of data requested here. We ask only that you do your best to provide as much information as possible so we can better help you. |
There was a problem hiding this comment.
It's nice that this is said explicitly 👍
The current issue template uses HTML comment tags to remove template text from the rendered output. I have gone through the last dozen issues filed, and it appears everyone deletes that anyways. By removing the comment tags, people can click "Preview" and get a pretty print of the template markdown. Reformat lists and links. Tries to get links as close to the left edge as possible, so they are easy to see, and copy-paste from the raw markdown editor. Puts multiple links on their own line for the same reason. Adds a request that they explicitly tell us what their AVA and `npm` versions are. Adds a section for their AVA config and CLI args. Adds a section for linking to thier project if public. Requests they create a minimal reproduction and post it to GitHub. Closes #787
|
Very good improvement. Thanks James. I manually merged and fixed @jfmengels comment. |
The current issue template uses HTML comment tags to remove template text from the rendered output. I have gone through the last dozen issues filed, and it appears everyone deletes that anyways. By removing the comment tags, people can click "Preview" and get a pretty print of the template markdown.
Reformat lists and links. Tries to get links as close to the left edge as possible, so they are easy to see, and copy-paste from the raw markdown editor. Puts multiple links on their own line for the same reason.
Adds a request that they explicitly tell us what their AVA and
npmversions are.Adds a section for their AVA config and CLI args.
Adds a section for linking to thier project if public.
Requests they create a minimal reproduction and post it to GitHub.