-
Notifications
You must be signed in to change notification settings - Fork 47
Create ISSUE_TEMPLATE.md #156
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
Conversation
This helps make new submissions as informative as possible in the first post. No more asking how to reproduce the issue.
This is in response to new issue where the pasted text was not backticked, so `\(` appeared as `(`
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this PR, this is something I've been wanted! I left a several comment, but they are just comments. Also I prefer the file name to be uppercased to move the issue template upward in the web browser.
issue_template.md
Outdated
<!-- | ||
Thanks for notifying us of a new issue! | ||
|
||
Before you submit, please make sure you do the following: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think these instructions can be a TODO list using a task list rather than a comment (comment cannot be seen in preview section). Good example I know would be a template for PRs in sindresorhus/atom-editorconfig.
issue_template.md
Outdated
<!-- | ||
Thanks for notifying us of a new issue! | ||
|
||
Before you submit, please make sure you do the following: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"please make sure you have done the following" sounds more natural to me, but I'm not sure if it really is (I'm not a native English speaker :-)).
Changed the tense, added the prerequisites section, and renamed file. Only using one checkbox to make it easier to use. (I get annoyed just having to delete a space and then put an X in one box, let alone several). |
Really? I always fill it out in the text, so I've never tried clicking it when viewing the preview. |
Besides, if they were going to be selective about which steps thay do, they'll probably still tick all the boxes regardless. I know I do that with some things (like the run in safe mode requirement; it probably won't change anything, unless you have a wacky setup). |
This may be true, but issue reporters should follow the instruction as long as the issue template tells them to do so don't they? |
Yeah, they should. I guess my position is that one box is just as good, or better, than multiple boxes. This is how it is on the https://github.com/atom/atom repository. Having said that, I will change it to multiple boxes if you prefer. It's not the biggest difference in the world, and I like to follow what others want for this package, while trying out my ideas on my own packages. |
Uh, I didn't mean to force multiple boxes and merged this only a few seconds after your reply. I just wanted to confirm the intention of the quoted text. Thanks again for this PR (I hope we don't see MWEs posted as an image anymore lol)! |
@yudai-nkt While, I'm at it, I think I'll make a PR template as well. I had to tell the guy in #160 to update the changelog as well, so giving contributors a checklist would be helpful to everyone. On a side note, as I say in the PR the proposed change closely resembles the existing patterns for citations, so I don't see any problem there. I'm just not sure how widely used the glossaries package is. |
This will provide a template for all new issue submissions, guiding people on how to make new submissions as informative as possible in the first post. No more asking how to reproduce the issue: they will know to have an example ready for anyone to copy and paste to immediately work with.
I put in the first line to feel more welcoming, but I'm open to any suggestions or changes (to any of it).