Switch to GitHub issue form templates

[xiehan]

I was chatting with @dbanck the other day and mentioned that since we switched to these templates on the CDK team, one nice side effect has been that we're seeing more contributions from the community thanks to the "Help Wanted" section. They've also generally resulted in issues that are more readable and actionable for us.

Feedback welcome, I'm happy to continue to tweak. I think the biggest thing to think about is what fields should be required vs. optional; ideally we'd avoid having 15 required fields for users to fill out because we don't want to discourage anyone from filing an issue.

If you haven't worked with issue templates before, one thing to note is that it's impossible (AFAIK) to preview the resulting forms in any way without first merging the code. So if you think this is "close enough" and you'd like to see it in action, we can also merge this PR, view the forms, and then open a new PR with additional tweaks.

[jpogran]

I think this is a great start!

[dbanck]

Merging this will probably break the `Generate Bug Report' command in VS Code, as it disables the creation of plain text issues.

Example URL generated from that command

We should investigate how to enable it again, or remove the command, which may be impossible since it's there for older versions of the extension.

[xiehan]

@dbanck It doesn't actually disable anything, it just hides it in the UI.

As proof, here's your link with vscode-terraform replaced with the CDK team's repo (which also uses the issue templates). The link still works anyway.

[radeksimko]

@xiehan I don't see the same config here in this repo, but I thought the main reason it appears to work in CDK, in spite of https://github.com/hashicorp/terraform-cdk/blob/main/.github/ISSUE_TEMPLATE/config.yml#L4 is because we're looking at the repo as someone with elevated privileges? I might be wrong though. It may be worth checking the experience under a GitHub account which is not part of the HashiCorp org, just to confirm.

[xiehan]

@radeksimko You all have it set up this way even today though: https://github.com/hashicorp/vscode-terraform/blob/main/.github/ISSUE_TEMPLATE/config.yml#L4 <-- I did not add that, this is already there.

[dbanck]

As proof, here's your link with vscode-terraform replaced with the CDK team's repo (which also uses the issue templates). The link still works anyway.

So the link works for you? For me it always redirects to https://github.com/hashicorp/terraform-cdk/issues/new/choose, so I assumed that plain text issues were disabled.

[xiehan]

Interesting, yeah it does work for me. I guess in that case Radek's point is true that it's because I have elevated privileges, but in general I don't think the issue you're pointing out has anything to do with plaintext vs. forms, it's the blank_issues_enabled setting which is currently false for this repo (I didn't touch that, it's been that way for 2 years), but maybe it should be changed true.

[dbanck]

Interesting!

I have confirmed with someone outside of HashiCorp that the Generate Bug Report link currently works for this repository.

Will check again after this is merged. Still confused about the setting, tho.

[github-actions]

I'm going to lock this pull request 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 related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.