Skip to content

Commit 7c3689a

Browse files
tenthirtyamtenthirtyam
authored
chore: add issue templates (#553)
Adds issue templates in the form format for bugs, documentation, and enhancements. Signed-off-by: Ryan Johnson <[email protected]>
1 parent a0396cf commit 7c3689a

File tree

5 files changed

+255
-115
lines changed

5 files changed

+255
-115
lines changed

‎.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
---
2+
name: Bug Report
3+
description: Is something not working as expected? Submit a bug.
4+
labels:
5+
- [bug, needs-triage]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Before filing an issue, please [search the existing issues](https://github.com/vmware/terraform-provider-vra/issues?q=is%3Aissue+is%3Aopen+label%3Abug) (open or closed), and use the [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) feature to add up-votes to existing issues.
11+
12+
When filing an issue, please include the following information.
13+
- type: checkboxes
14+
id: terms
15+
attributes:
16+
label: Code of Conduct
17+
description: The Code of Conduct applies to you when interacting with the community here on GitHub and contributing code.
18+
options:
19+
- label: I have read and agree to the [Code of Conduct](https://github.com/vmware/terraform-provider-vra/blob/main/CODE_OF_CONDUCT.md).
20+
required: true
21+
- label: 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 initial description to help the maintainers prioritize.
22+
required: false
23+
- label: Do not leave "+1" or other comments that do not add relevant information or questions.
24+
required: false
25+
- label: If you are interested in working on this issue or have submitted a pull request, please leave a comment.
26+
required: false
27+
- type: input
28+
id: version-terraform
29+
attributes:
30+
label: Terraform
31+
description: Please provide the Terraform version.
32+
placeholder: e.g. x.y.z
33+
validations:
34+
required: true
35+
- type: input
36+
id: version-provider
37+
attributes:
38+
label: Terraform Provider
39+
description: |
40+
Please provide the provider version.
41+
We recommend testing with [the latest version of the provider](https://github.com/vmware/terraform-provider-vra/releases/latest).
42+
placeholder: e.g. x.y.x
43+
validations:
44+
required: true
45+
- type: input
46+
id: version-product
47+
attributes:
48+
label: VMware Aria Automation
49+
description: |
50+
Please provide the VMware Aria version.
51+
placeholder: e.g. x.y.z
52+
validations:
53+
required: true
54+
- type: textarea
55+
id: description
56+
attributes:
57+
label: Description
58+
description: Please provide a clear and concise description of the issue you are experiencing.
59+
validations:
60+
required: true
61+
- type: textarea
62+
id: affected-resources-datasources
63+
attributes:
64+
label: Affected Resources or Data Sources
65+
description: Please provide the affected resources or data sources as a list.
66+
placeholder: |
67+
e.g. `resource/example` or `datasource/example`
68+
validations:
69+
required: true
70+
- type: textarea
71+
id: configuration
72+
attributes:
73+
label: Terraform Configuration
74+
description: |
75+
- Please provide a code repository, [GitHub Gist](https://gist.github.com/), or simplified code sample suitable for issue reproduction.
76+
- Please ensure all secrets and identifiable information is removed.
77+
- Please format any code in code blocks using the markdown editor.
78+
79+
Learn more about [Code Formatting](https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code).
80+
placeholder: |
81+
Please format any code in code blocks using the markdown editor.
82+
validations:
83+
required: true
84+
- type: textarea
85+
id: debug
86+
attributes:
87+
label: Debug Output
88+
description: |
89+
Please provide a link to a [GitHub Gist](https://gist.github.com/) containing the complete debug output.
90+
placeholder: |
91+
Link to a GitHub Gist. Please do not paste the debug output in the issue.
92+
validations:
93+
required: true
94+
- type: textarea
95+
id: panic
96+
attributes:
97+
label: Panic Output
98+
description: |
99+
If Terraform produced a panic, please provide a link to a [GitHub Gist](https://gist.github.com/) containing the output of the `crash.log`
100+
placeholder: |
101+
Link to a GitHub Gist. Please do not paste the panic output in the issue.
102+
validations:
103+
required: false
104+
- type: textarea
105+
id: expected-behavior
106+
attributes:
107+
label: Expected Behavior
108+
description: |
109+
What is it you expected to happen?
110+
This should be a description of how the functionality you tried to use is supposed to work.
111+
validations:
112+
required: true
113+
- type: textarea
114+
id: actual-behavior
115+
attributes:
116+
label: Actual Behavior
117+
description: What actually happened that's different from the expected behavior?
118+
validations:
119+
required: true
120+
- type: textarea
121+
id: steps-to-reproduce
122+
attributes:
123+
label: Steps to Reproduce
124+
description: Please provide the steps to reproduce the issue.
125+
validations:
126+
required: true
127+
- type: textarea
128+
id: environment
129+
attributes:
130+
label: Environment Details
131+
description: Please add any additional information you can provide about the environment.
132+
validations:
133+
required: false
134+
- type: textarea
135+
id: screenshots
136+
attributes:
137+
label: Screenshots
138+
description: Screenshots of the issue, if applicable.
139+
validations:
140+
required: false
141+
- type: textarea
142+
id: references
143+
attributes:
144+
label: References
145+
description: |
146+
Please provide any related GitHub issues or pull requests (open or closed) or documentation.
147+
Learn about [Referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests).
148+
placeholder: |
149+
#GH-0000
150+
validations:
151+
required: false

‎.github/ISSUE_TEMPLATE/bug_report.md

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

‎.github/ISSUE_TEMPLATE/docs.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Documentation
3+
description: Found a typo or something that needs clarification?
4+
labels:
5+
- [documentation, needs-review]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
When filing a documentation issue, please include the following information.
11+
- type: checkboxes
12+
id: terms
13+
attributes:
14+
label: Code of Conduct
15+
description: >-
16+
This project has a [Code of Conduct](https://github.com/vmware/terraform-provider-tanzu-mission-control/blob/main/CODE_OF_CONDUCT.md)
17+
that all participants are expected to understand and follow.
18+
options:
19+
- label: I have read and agree to the project's Code of Conduct.
20+
required: true
21+
- type: input
22+
id: version-provider
23+
attributes:
24+
label: Provider Version
25+
description: Please provide the provider version.
26+
placeholder: e.g. x.y.z
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: motivation
31+
attributes:
32+
label: Motivation
33+
description: Why should we update our docs or examples?
34+
validations:
35+
required: false
36+
- type: textarea
37+
id: suggestion
38+
attributes:
39+
label: Suggestion
40+
description: What should we do instead?
41+
validations:
42+
required: false
43+
- type: markdown
44+
attributes:
45+
value: "### Community Note\n* Please vote on this issue by adding a \U0001F44D [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\n* Please do not leave \"+1\" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request\n* If you are interested in working on this issue or have submitted a pull request, please leave a comment\n"

‎.github/ISSUE_TEMPLATE/enhancement.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
name: Enhancement Request
3+
description: Is something critical missing? Suggest an enhancement.
4+
labels:
5+
- [enhancement, needs-review]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
Before filing an enhancement, please search the existing issues and use the
11+
[reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/)
12+
feature to add up-votes to existing requests.
13+
14+
15+
When filing an enhancement, please include the following information.
16+
- type: checkboxes
17+
id: terms
18+
attributes:
19+
label: Code of Conduct
20+
description: >-
21+
This project has a [Code of Conduct](https://github.com/vmware/terraform-provider-tanzu-mission-control/blob/main/CODE_OF_CONDUCT.md)
22+
that all participants are expected to understand and follow.
23+
options:
24+
- label: I have read and agree to the project's Code of Conduct.
25+
required: true
26+
- label: 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 initial description to help the maintainers prioritize.
27+
required: false
28+
- label: Do not leave "+1" or other comments that do not add relevant information or questions.
29+
required: false
30+
- label: If you are interested in working on this issue or have submitted a pull request, please leave a comment.
31+
required: false
32+
- type: textarea
33+
id: description
34+
attributes:
35+
label: Description
36+
description: A written overview of the enhancement.
37+
validations:
38+
required: true
39+
- type: textarea
40+
id: use-case
41+
attributes:
42+
label: Use Case(s)
43+
description: Any relevant use-cases that you see.
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: potential-configuration
48+
attributes:
49+
label: Potential Configuration
50+
description: Provide a potential configuration.
51+
validations:
52+
required: true
53+
- type: textarea
54+
id: references
55+
attributes:
56+
label: References
57+
description: Provide any references.
58+
validations:
59+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.md

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

0 commit comments

Comments
 (0)