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

HCPE-995 - Add issue lifecycle documentation and issue templates #93

Merged
merged 2 commits into from
Mar 31, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 0 additions & 43 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

89 changes: 89 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
---
name: 🐛 Bug Report
about: If something isn't working as expected 🤔.
labels: bug
---

<!---
Please note the following potential times when an issue might be in Terraform core:
roaks3 marked this conversation as resolved.
Show resolved Hide resolved

* [Configuration Language](https://www.terraform.io/docs/configuration/index.html) or resource ordering issues
* [State](https://www.terraform.io/docs/state/index.html) and [State Backend](https://www.terraform.io/docs/backends/index.html) issues
* [Provisioner](https://www.terraform.io/docs/provisioners/index.html) issues
* [Registry](https://registry.terraform.io/) issues
* Spans resources across multiple providers

If you are running into one of these scenarios, we recommend opening an issue in the [Terraform core repository](https://github.com/hashicorp/terraform/) instead.
--->

### Terraform Version and Provider Version

<!--- Please run `terraform -v` to show the Terraform core version and provider version(s). If you are not running the latest version of Terraform or the provider, please upgrade because your issue may have already been fixed. [Terraform documentation on provider versioning](https://www.terraform.io/docs/configuration/providers.html#provider-versions). --->

```
Terraform version:
HCP provider version:
```

### Affected Resource(s)

<!--- Please list the affected resources and data sources. --->

* hcp_XXXXX

### Terraform Configuration Files

<!--- Please include all Terraform configurations required to reproduce the bug. Bug reports without a functional reproduction may be closed without investigation. --->

```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

<!---
Please provide a link to a GitHub Gist containing the complete debug output. Please do NOT paste the debug output in the issue; just paste a link to the Gist.

To obtain the debug output, see the [Terraform documentation on debugging](https://www.terraform.io/docs/internals/debugging.html).
--->

### Panic Output

<!--- If Terraform produced a panic, please provide a link to a GitHub Gist containing the output of the `crash.log`. --->

### Steps to Reproduce

<!--- Please list the steps required to reproduce the issue. --->

1. `terraform apply`

### Expected Behavior

<!--- What should have happened? --->

### Actual Behavior

<!--- What actually happened? --->

### Important Factoids

<!--- Are there anything atypical about your accounts that we should know? --->
roaks3 marked this conversation as resolved.
Show resolved Hide resolved

### References

<!---
Are there any other GitHub issues (open or closed) or pull requests that should be linked here?
--->

* #0000

<!--- Please keep this note for the community --->

### 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

<!--- Thank you for keeping this note for the community --->
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: 🚀 Feature Request
about: I have a suggestion (and might want to implement myself 🙂)!
labels: enhancement
---

### Description

<!--- Please leave a helpful description of the feature request here. --->
roaks3 marked this conversation as resolved.
Show resolved Hide resolved

### New or Affected Resource(s)

<!--- Please list the new or affected resources and data sources. --->

* 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

<!---
Are there any other GitHub issues (open or closed) or pull requests that should be linked here?
--->

* #0000

<!--- Please keep this note for the community --->

### 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

<!--- Thank you for keeping this note for the community --->
55 changes: 55 additions & 0 deletions contributing/issue-lifecycle.md
Original file line number Diff line number Diff line change
@@ -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.