Skip to content

Commit 31bb507

Browse files
austinvalleaustinvalle
authored
Add issue templates and external links for feedback + questions (#95)
* Add issue templates and external links for feedback * switch to issue forms
1 parent a0a1cf2 commit 31bb507

File tree

4 files changed

+115
-1
lines changed

4 files changed

+115
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: Bug Report
2+
description: Let us know about an unexpected error, a crash, or an incorrect behavior.
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for taking the time to fill out this bug report! Please note that this issue tracker is only used for bug reports and feature requests. Other issues will be closed.
9+
10+
If you have a question or want to provide general feedback about code generation, please go back to the issue chooser and select one of the discuss board links.
11+
- type: textarea
12+
id: version
13+
attributes:
14+
label: tfplugingen-openapi CLI version
15+
description: What is the version of the OpenAPI Provider Spec Generator CLI?
16+
placeholder: Output of `tfplugingen-openapi --version`
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: openapi-spec
21+
attributes:
22+
label: OpenAPI Spec File
23+
description: Please copy and paste any relevant content of the OpenAPI specification used
24+
render: YAML
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: generator-config
29+
attributes:
30+
label: Generator Config
31+
description: Please copy and paste the content of the generator config used
32+
render: YAML
33+
validations:
34+
required: true
35+
- type: textarea
36+
id: expected-behavior
37+
attributes:
38+
label: Expected Behavior
39+
description: What did you expect to happen?
40+
placeholder: Description of what should have happened.
41+
validations:
42+
required: true
43+
- type: textarea
44+
id: actual-behavior
45+
attributes:
46+
label: Actual Behavior
47+
description: What actually happened?
48+
placeholder: Description of what actually happened.
49+
validations:
50+
required: true
51+
- type: textarea
52+
id: additional-information
53+
attributes:
54+
label: Additional Information
55+
description: Are there any additional details about your environment, workflow, or recent changes that might be relevant? Have you discovered a workaround? Are there links to other related issues?
56+
validations:
57+
required: false
58+
- type: checkboxes
59+
id: terms
60+
attributes:
61+
label: Code of Conduct
62+
description: By submitting this issue, you agree to follow our [Community Guidelines](https://www.hashicorp.com/community-guidelines).
63+
options:
64+
- label: I agree to follow this project's Code of Conduct
65+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Code Generation Feedback
4+
url: https://discuss.hashicorp.com/c/terraform-providers/tf-plugin-sdk
5+
about: Please share any overall feedback relating to provider code generation by creating a new topic in the Plugin Development Community Forum.
6+
- name: ❓ Code Generation Questions
7+
url: https://discuss.hashicorp.com/c/terraform-providers/tf-plugin-sdk
8+
about: Please ask any general questions about provider code generation by creating a new topic in the Plugin Development Community Forum.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Feature Request
2+
description: Something is missing or could be improved.
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for taking the time to fill out this feature request! Please note that this issue tracker is only used for bug reports and feature requests. Other issues will be closed.
9+
10+
If you have a question or want to provide general feedback about code generation, please go back to the issue chooser and select one of the discuss board links.
11+
- type: textarea
12+
id: use-case
13+
attributes:
14+
label: Use Cases or Problem Statement
15+
description: What use cases or problems are you trying to solve?
16+
placeholder: Description of use cases or problems.
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: proposal
21+
attributes:
22+
label: Proposal
23+
description: What solutions would you prefer?
24+
placeholder: Description of proposed solutions.
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: additional-information
29+
attributes:
30+
label: Additional Information
31+
description: Are there any additional details about your environment, workflow, or recent changes that might be relevant? Have you discovered a workaround? Are there links to other related issues?
32+
validations:
33+
required: false
34+
- type: checkboxes
35+
id: terms
36+
attributes:
37+
label: Code of Conduct
38+
description: By submitting this issue, you agree to follow our [Community Guidelines](https://www.hashicorp.com/community-guidelines).
39+
options:
40+
- label: I agree to follow this project's Code of Conduct
41+
required: true

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# OpenAPI Provider Spec Generator
22

3-
> _[Terraform Provider Code Generation](https://developer.hashicorp.com/terraform/plugin/code-generation) is currently in tech preview._
3+
> _[Terraform Provider Code Generation](https://developer.hashicorp.com/terraform/plugin/code-generation) is currently in tech preview. If you have general questions or feedback about provider code generation, please create a new topic in the [Plugin Development Community Forum](https://discuss.hashicorp.com/c/terraform-providers/tf-plugin-sdk)._
44
55
## Overview
66

0 commit comments

Comments
 (0)