diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 8066d3921..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,43 +0,0 @@ -Hi there, - -Thank you for opening an issue. Please note that we try to keep the Terraform issue tracker reserved for bug reports and feature requests. For general usage questions, please see: https://www.terraform.io/community.html. - -### Terraform Version -Run `terraform -v` to show the version. If you are not running the latest version of Terraform, please upgrade because your issue may have already been fixed. - -### Affected Resource(s) -Please list the resources as a list, for example: -- opc_instance -- opc_storage_volume - -If this issue appears to affect multiple resources, it may be an issue with Terraform's core, so please mention this. - -### Terraform Configuration Files -```hcl -# Copy-paste your Terraform configurations here - for large Terraform configs, -# please use a service like Dropbox and share a link to the ZIP file. For -# security, you can also encrypt the files using our GPG public key. -``` - -### Debug Output -Please provider a link to a GitHub Gist containing the complete debug output: https://www.terraform.io/docs/internals/debugging.html. Please do NOT paste the debug output in the issue; just paste a link to the Gist. - -### Panic Output -If Terraform produced a panic, please provide a link to a GitHub Gist containing the output of the `crash.log`. - -### Expected Behavior -What should have happened? - -### Actual Behavior -What actually happened? - -### Steps to Reproduce -Please list the steps required to reproduce the issue, for example: -1. `terraform apply` - -### Important Factoids -Are there anything atypical about your accounts that we should know? For example: Running in EC2 Classic? Custom version of OpenStack? Tight ACLs? - -### References -Are there any other GitHub issues (open or closed) or Pull Requests that should be linked here? For example: -- GH-1234 diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 000000000..fa143c15d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,89 @@ +--- +name: 🐛 Bug Report +about: If something isn't working as expected 🤔. +labels: bug +--- + + + +### Terraform Version and Provider Version + + + +``` +Terraform version: +HCP provider version: +``` + +### Affected Resource(s) + + + +* hcp_XXXXX + +### Terraform Configuration Files + + + +```hcl +# Copy-paste your Terraform configurations here - for large Terraform configs, +# please use a service like Dropbox and share a link to the ZIP file. For +# security, you can also encrypt the files using our GPG public key: https://keybase.io/hashicorp +``` + +### Debug Output + + + +### Panic Output + + + +### Steps to Reproduce + + + +1. `terraform apply` + +### Expected Behavior + + + +### Actual Behavior + + + +### Important Factoids + + + +### References + + + +* #0000 + + + +### Community Note + +* Please 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 to help the community and maintainers prioritize this request +* If you are interested in working on this issue or have submitted a pull request, please leave a comment + + diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 000000000..36475e504 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,40 @@ +--- +name: 🚀 Feature Request +about: I have a suggestion (and might want to implement myself 🙂)! +labels: enhancement +--- + +### Description + + + +### New or Affected Resource(s) + + + +* hcp_XXXXX + +### Potential Terraform Configuration + +```hcl +# Copy-paste your Terraform configurations here - for large Terraform configs, +# please use a service like Dropbox and share a link to the ZIP file. For +# security, you can also encrypt the files using our GPG public key: https://keybase.io/hashicorp +``` + +### References + + + +* #0000 + + + +### Community Note + +* Please 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 to help the community and maintainers prioritize this request +* If you are interested in working on this issue or have submitted a pull request, please leave a comment + + diff --git a/contributing/issue-lifecycle.md b/contributing/issue-lifecycle.md new file mode 100644 index 000000000..0aa119762 --- /dev/null +++ b/contributing/issue-lifecycle.md @@ -0,0 +1,55 @@ +# Issue Reporting and Lifecycle + +## Issue Reporting Checklists + +We welcome your feature requests and bug reports. Below you'll find short checklists with guidelines for well-formed +issues of each type. + +### [Bug Reports](https://github.com/hashicorp/terraform-provider-hcp/issues/new/choose) + + - [ ] __Test against the latest release__: Make sure you test against the latest + released version. It is possible we already fixed the bug you're experiencing. + +- [ ] __Search for possible duplicate reports__: It's helpful to keep bug + reports consolidated to one thread, so do a quick search on existing bug + reports to check if anybody else has reported the same thing. You can [scope + searches by the label "bug"](https://github.com/hashicorp/terraform-provider-hcp/issues?q=is%3Aopen+is%3Aissue+label%3Abug) to help narrow things down. + +- [ ] __Include steps to reproduce__: Provide steps to reproduce the issue, + along with your `.tf` files, with secrets removed, so we can try to + reproduce it. Without this, it makes it much harder to fix the issue. + +- [ ] __For panics, include `crash.log`__: If you experienced a panic, please + create a [gist](https://gist.github.com) of the *entire* generated crash log + for us to look at. Double check no sensitive items were in the log. + +### [Feature Requests](https://github.com/hashicorp/terraform-provider-hcp/issues/new/choose) + +- [ ] __Search for possible duplicate requests__: It's helpful to keep requests + consolidated to one thread, so do a quick search on existing requests to + check if anybody else has reported the same thing. You can [scope searches by + the label "enhancement"](https://github.com/hashicorp/terraform-provider-hcp/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) to help narrow things down. + +- [ ] __Include a use case description__: In addition to describing the + behavior of the feature you'd like to see added, it's helpful to also lay + out the reason why the feature would be important and how it would benefit + Terraform users. + +## Issue Lifecycle + +1. The issue is reported on Github. + +2. The issue is verified and categorized by a provider team member. + Categorization is done via GitHub labels. We use + one of `bug`, `enhancement`, `documentation`, or `question` using some automated workflows. + +3. An initial triage process determines whether the issue is critical and must + be addressed immediately, or can be left open for community discussion. + +4. The issue is addressed in a pull request or commit. The issue number will be + referenced in the commit message so that the code that fixes it is clearly + linked. + +5. The issue is closed. Sometimes, valid issues will be closed because they are + tracked elsewhere or non-actionable. The issue is still indexed and + available for future viewers, or can be re-opened if necessary.