-
Notifications
You must be signed in to change notification settings - Fork 9.6k
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
Add issue_template #6017
Add issue_template #6017
Conversation
fixed. | ||
|
||
### Affected Resource(s) | ||
Please list the resources as a list, for example: |
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.
Maybe also something like: "if the issue appears to affect multiple resources and may be an issue with the core of Terraform, please also mention this".
@jen20 added those things |
I kind of like the Homebrew's checklist-style: https://github.com/Homebrew/homebrew-core/blob/master/.github/ISSUE_TEMPLATE.md I wonder if there's any way we could turn this into a checklist too. I'm thinking it may feel more natural for people reporting bugs to tick boxes and fill in gaps in the text, instead of removing it and/or answering questions. e.g.
|
Hi @radeksimko The problem I have with Homebrew's template is that those checkboxes only show up after you create the issue, and they aren't versioned or anything. As a result, anyone with permissions can check/uncheck, and when I get an email from GitHub, it might not contain the right "checkboxes". For non-technical users, they might not be familiar with the markdown syntax for |
@sethvargo Thanks for the explanation, these reasons make sense. Sometimes I see things only from my POV - i.e. someone who knows markdown quite well and almost doesn't see the difference between raw and rendered markdown. 😃 |
ac5c7a5
to
bcaf46e
Compare
I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
This adds a new issues template modeled after the one we've been using for Vagrant. It mirrors a lot of the information already contained in the CONTRIBUTING.md, but provides a consistent template for new issues to follow as well as some examples.
This text will pre-fill when someone goes to create a new issue.
/cc @phinze @catsby