Skip to content

Commit 2cd700a

Browse files
alexng-canuckalexng-canuck
committed
Update issue templates to help categorize issues and ask for more information
This issue template now conforms with the structure in other Terraform providers. It also provides more guidance on filing issues and helps with labelling.
1 parent 96ba787 commit 2cd700a

File tree

5 files changed

+153
-27
lines changed

5 files changed

+153
-27
lines changed

‎.github/ISSUE_TEMPLATE‎

Lines changed: 0 additions & 27 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<!---
2+
Thanks for filing an issue 😄 ! Before you submit, please read the following:
3+
4+
Check the other issue templates if you are trying to submit a bug report, feature request, or question
5+
Search open/closed issues before submitting since someone might have asked the same thing before!
6+
-->

‎.github/ISSUE_TEMPLATE/Bug_Report.md‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: If something isn't working as expected 🤔.
4+
labels: bug
5+
---
6+
7+
<!---
8+
Please note the following potential times when an issue might be in Terraform core:
9+
10+
* [Configuration Language](https://www.terraform.io/docs/configuration/index.html) or resource ordering issues
11+
* [State](https://www.terraform.io/docs/state/index.html) and [State Backend](https://www.terraform.io/docs/backends/index.html) issues
12+
* [Provisioner](https://www.terraform.io/docs/provisioners/index.html) issues
13+
* [Registry](https://registry.terraform.io/) issues
14+
* Spans resources across multiple providers
15+
16+
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.
17+
--->
18+
19+
<!--- Please keep this note for the community --->
20+
21+
### Community Note
22+
23+
* 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
24+
* Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
25+
* If you are interested in working on this issue or have submitted a pull request, please leave a comment
26+
27+
<!--- Thank you for keeping this note for the community --->
28+
29+
### Terraform Version and Provider Version
30+
31+
<!--- Please run `terraform -v` to show the Terraform core version and provider version(s).
32+
If you are using a local copy of the Terraform Oracle Cloud Infrastructure Provider, run the plugin directly to get the version: `<path-to-plugin>/terraform-provider-oci`
33+
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). --->
34+
35+
### Affected Resource(s)
36+
37+
<!--- Please list the affected resources and data sources. For example, "oci_core_vcn". --->
38+
39+
40+
### Terraform Configuration Files
41+
42+
<!--- Information about code formatting: https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code --->
43+
44+
```hcl
45+
# Copy-paste your Terraform configurations here - for large Terraform configs,
46+
# please use a service like Dropbox and share a link to the ZIP file.
47+
# Please remove any sensitive information from configuration files before sharing them.
48+
```
49+
50+
### Debug Output
51+
52+
<!---
53+
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.
54+
55+
To obtain the debug output, see the [Verbose logging for OCI Terraform Provider](https://www.terraform.io/docs/providers/oci/guides/troubleshooting.html#verbose-logging-for-oci-terraform-provider).
56+
57+
Github Gist: https://gist.github.com/
58+
--->
59+
60+
### Panic Output
61+
62+
<!---
63+
If Terraform produced a panic, please provide a link to a GitHub Gist containing the output of the `crash.log`.
64+
65+
Github Gist: https://gist.github.com/
66+
--->
67+
68+
### Expected Behavior
69+
70+
<!--- What should have happened? --->
71+
72+
### Actual Behavior
73+
74+
<!--- What actually happened? --->
75+
76+
### Steps to Reproduce
77+
78+
<!--- Please list the steps required to reproduce the issue. --->
79+
80+
1. `terraform apply`
81+
82+
### Important Factoids
83+
84+
<!--- Is there anything atypical about your environment that we should know? For example: Is the issue specific to a region? --->
85+
86+
### References
87+
88+
<!---
89+
Information about referencing Github Issues: https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests
90+
91+
Are there any other GitHub issues (open or closed) or pull requests that should be linked here? Vendor documentation? For example:
92+
--->
93+

‎.github/ISSUE_TEMPLATE/Feature_Request.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: 🚀 Feature Request
3+
about: I have a suggestion (and might want to implement myself 🙂)!
4+
labels: enhancement
5+
---
6+
7+
<!--- Please keep this note for the community --->
8+
9+
### Community Note
10+
11+
* 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
12+
* Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
13+
* If you are interested in working on this issue or have submitted a pull request, please leave a comment
14+
15+
<!--- Thank you for keeping this note for the community --->
16+
17+
### Description
18+
19+
<!--- Please leave a helpful description of the feature request here. --->
20+
21+
### New or Affected Resource(s)
22+
23+
<!--- Please list any new or affected resources and data sources that are part of the request. For example: "oci_core_vcn" --->
24+
25+
26+
### Potential Terraform Configuration
27+
28+
<!--- Information about code formatting: https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code --->
29+
30+
```hcl
31+
# Copy-paste any Terraform configurations for how the requested feature may be used.
32+
```
33+
34+
### References
35+
36+
<!---
37+
Information about referencing Github Issues: https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests
38+
39+
Are there any other GitHub issues (open or closed) or pull requests that should be linked here? Vendor blog posts or documentation? For example:
40+
41+
--->
42+

‎.github/ISSUE_TEMPLATE/Question.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
name: 💬 Question
3+
about: Questions regarding the Terraform Oracle Cloud Infrastructure provider
4+
labels: question
5+
---
6+
7+
This Github template is intended for questions regarding the Terraform **Oracle Cloud Infrastructure** provider.
8+
9+
If you have a support request or question related to core Terraform functionality, please submit them to one of these resources:
10+
11+
* [Terraform community resources](https://www.terraform.io/docs/extend/community/index.html)
12+
* [HashiCorp support](https://support.hashicorp.com) (Terraform Enterprise customers)

0 commit comments

Comments
 (0)