Skip to content

Commit ea728e0

Browse files
tenthirtyamtenthirtyam
authored
chore(xfer): update issue templates (#611)
Replaces Markdown-based issue templates with YAML-based issue forms. This update provides a more structured and user-friendly experience for submitting issues. Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>
1 parent 40ab2ac commit ea728e0

5 files changed

Lines changed: 270 additions & 117 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug.yml‎

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

‎.github/ISSUE_TEMPLATE/bug_report.md‎

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

‎.github/ISSUE_TEMPLATE/docs.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: Documentation
3+
description: Found a typo or something that needs clarification?
4+
labels:
5+
- documentation
6+
- needs-review
7+
type: task
8+
projects:
9+
- vmware/48
10+
body:
11+
- type: markdown
12+
attributes:
13+
value: >
14+
When filing a documentation issue, please include the following information.
15+
- type: checkboxes
16+
id: terms
17+
attributes:
18+
label: Code of Conduct
19+
description: The Code of Conduct applies to you when interacting with the community here on GitHub and contributing code.
20+
options:
21+
- label: I have read and agree to the [Code of Conduct](https://github.com/vmware/packer-plugin-vsphere/blob/main/CODE_OF_CONDUCT.md).
22+
required: true
23+
- 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 description to help the maintainers prioritize.
24+
required: false
25+
- label: Do not leave "+1" or other comments that do not add relevant information or questions.
26+
required: false
27+
- label: If you are interested in working on this issue or have submitted a pull request, please leave a comment.
28+
required: false
29+
- type: textarea
30+
id: detail
31+
attributes:
32+
label: Detail
33+
description: What part of the documentation needs to be changed?
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: suggestion
38+
attributes:
39+
label: Suggestion
40+
description: How should the documentation be changed to address the issue?
41+
validations:
42+
required: false

‎.github/ISSUE_TEMPLATE/enhancement.yml‎

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

‎.github/ISSUE_TEMPLATE/feature_requests.md‎

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

0 commit comments

Comments
 (0)