Convert bug report issue template to form #1546
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR converts TFLint's bug report issue template into an issue form. I also plan to convert the feature template in a later PR.
I've been noticing a lot of low-effort bug reports that skip over critical details that would be needed to diagnose and solve the issue. Most often, this missing information is Terraform configuration in a large/complex module that the submitter doesn't want to hassle with isolating. Understandable, but an incomplete bug report does no one any good.
In addition to structuring the existing template as a form, I've made the following additions/changes:
tflint
is populated by default.input
.terraform -v
which prints$GOOS_$GOARCH
as part of its output. We could add this totflint -v
and go back to atextarea
for that and remove this field entirely. I also internally debated whether this should be adropdown
orcheckboxes
. It's common to use macOS locally and Linux on the server so I went with checkboxes.Syntax for issue forms:
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#input