Skip to content
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

Convert bug report issue template to form #1546

Merged
merged 6 commits into from
Nov 10, 2022
Merged

Convert bug report issue template to form #1546

merged 6 commits into from
Nov 10, 2022

Conversation

bendrucker
Copy link
Member

@bendrucker bendrucker commented Oct 12, 2022

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:

  • Users are encouraged to report ruleset-specific issues in their corresponding repository.
  • The summary is expected to be plain, concise text, whereas the Introduction section of the template called for an HCL code block, without explanation of what that content should be.
  • Users are required to specify the Command they used. While required, the value tflint is populated by default.
  • Users are required to specify the Terraform Configuration. In the very rare case that the issue is not related to the root module (e.g., plugin downloading), users can enter a placeholder value. I'll either add a note about this to the description or consider making another form specifically for plugin issues.
  • Users are required to specify the TFLint Configuration.
  • Users are required to specify the Output.
  • Users are required to specify the TFLint Version. For now, this is a simple input.
  • Users are allowed to specify the Terraform Version, but are only encouraged to do so for cases where Terraform can parse the config but TFLint cannot.
  • Users are asked to specify the operating systems where they've reproduced the problem. Previously this would have come from terraform -v which prints $GOOS_$GOARCH as part of its output. We could add this to tflint -v and go back to a textarea for that and remove this field entirely. I also internally debated whether this should be a dropdown or checkboxes. 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

@bendrucker bendrucker marked this pull request as draft October 12, 2022 18:47
@bendrucker bendrucker marked this pull request as ready for review November 10, 2022 00:42
@bendrucker bendrucker requested a review from wata727 November 10, 2022 00:43
Copy link
Member

@wata727 wata727 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice 👍

@bendrucker bendrucker merged commit 6b61aaa into master Nov 10, 2022
@bendrucker bendrucker deleted the issue-forms branch November 10, 2022 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants