chore: add issue templates #1430
Conversation
tenthirtyam
force-pushed
the
chore/add-issue-templates
branch
from
c5c8ec8 to
c518311
Compare
|
@ksamoray @annakhm @salv-orlando - Could you review this item for adding form-based issue templates? |
|
@vmware/terraform-provider-nsxt-maintainers: reminder. |
Adds issue templates in the form format for bugs, documentation, and enhancements. Signed-off-by: Ryan Johnson <[email protected]>
tenthirtyam
force-pushed
the
chore/add-issue-templates
branch
from
c518311 to
4ae34db
Compare
| description: | | ||
| Please provide a link to a [GitHub Gist](https://gist.github.com/) containing the complete debug output. | ||
| placeholder: | | ||
| Link to a GitHub Gist. Please do not paste the debug output in the issue. |
There was a problem hiding this comment.
To be fair, we're actually fine if users post the output directly on the issue. In many cases they just paste the relevant snippet.
Can we rephrase this to something like:
Link to a GitHub Gist and/or paste a snippet from the debug log which will be informative enough to allow us to root cause the issue
| description: | | ||
| If Terraform produced a panic, please provide a link to a [GitHub Gist](https://gist.github.com/) containing the output of the `crash.log` | ||
| placeholder: | | ||
| Link to a GitHub Gist. Please do not paste the panic output in the issue. |
There was a problem hiding this comment.
As above. Often the panic is easily identified by a small stack trace.
| @@ -0,0 +1 @@ | |||
| blank_issues_enabled: false | |||
There was a problem hiding this comment.
Can we not do this? Mostly for self-filed issues, we might not want to go through the whole template.
| options: | ||
| - label: I have read and agree to the [Code of Conduct](https://github.com/vmware/terraform-provider-nsxt/blob/main/CODE_OF_CONDUCT.md). | ||
| required: true | ||
| - label: Vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue initial description to help the maintainers prioritize. |
There was a problem hiding this comment.
Can we have lines 21-26 in a markdown section as for the documentation template?
| options: | ||
| - label: I have read and agree to the project's Code of Conduct. | ||
| required: true | ||
| - label: Vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue initial description to help the maintainers prioritize. |
There was a problem hiding this comment.
Same comment as for bug.YML
Summary of Pull Request
Adds issue templates in the form format for:
Type of Pull Request
Please describe:
Related to Existing Issues
Test and Documentation Coverage
For bug fixes or features:
Breaking Changes?