Skip to content

Commit 0cf8f14

Browse files
rohanKanojiarohanKanojia
committed
chore : Update CRC GitHub issue template to be more interactive
CRC project is using quite old style issue template. Update it to be more interactive so that users can provide information easily. Signed-off-by: Rohan Kumar <rohaan@redhat.com>
1 parent 28b72b7 commit 0cf8f14

File tree

5 files changed

+280
-62
lines changed

5 files changed

+280
-62
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

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

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
name: Bug report 🐞
2+
description: Report a bug
3+
labels: [kind/bug]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
### Creating a new Bug 🐞
10+
🔍 Before opening a new issue please search existing issues at https://github.com/crc-org/crc/issues
11+
12+
🤔 To make it easier for us to help you, please include as much useful information as possible.
13+
14+
Useful Links:
15+
- 📄 Documentation: https://crc.dev/docs/introducing/
16+
- 📝 Contributing: https://crc.dev/engineering-docs/
17+
18+
- type: textarea
19+
id: general-info
20+
attributes:
21+
label: General information
22+
description: A clear and concise description of what the bug is.
23+
placeholder: Describe the bug
24+
validations:
25+
required: true
26+
27+
- type: dropdown
28+
id: os
29+
attributes:
30+
label: Operating System
31+
description: Which Operating System are you running CRC on?
32+
multiple: false
33+
options:
34+
- Linux
35+
- macOS
36+
- Windows
37+
validations:
38+
required: true
39+
40+
- type: dropdown
41+
id: hypervisor
42+
attributes:
43+
label: Hypervisor
44+
description: Which Operating System are you running CRC on?
45+
multiple: false
46+
options:
47+
- KVM
48+
- Hyper-V
49+
- hyperkit
50+
- vfkit
51+
validations:
52+
required: true
53+
54+
- type: dropdown
55+
id: crcsetup
56+
attributes:
57+
label: Did you run `crc setup` before `crc start`?
58+
description: Did you run `crc setup` before starting it ?
59+
multiple: false
60+
options:
61+
- 'yes'
62+
- 'no'
63+
validations:
64+
required: true
65+
66+
- type: dropdown
67+
id: running-on
68+
attributes:
69+
label: Running on
70+
description: Running CRC on
71+
multiple: false
72+
options:
73+
- Laptop
74+
- Baremetal-Server
75+
- VM
76+
validations:
77+
required: true
78+
79+
- type: textarea
80+
id: steps
81+
attributes:
82+
label: Steps to reproduce
83+
description: What are the steps to reproduce this bug ?
84+
placeholder: |
85+
1. Do '...'
86+
2. See error
87+
validations:
88+
required: true
89+
90+
- type: textarea
91+
id: version
92+
attributes:
93+
label: CRC version
94+
placeholder: |
95+
# Put `crc version` output here
96+
description:
97+
render: shell
98+
99+
- type: textarea
100+
id: status
101+
attributes:
102+
label: CRC status
103+
placeholder: |
104+
# Put `crc status --log-level debug` output here
105+
description:
106+
render: shell
107+
108+
- type: textarea
109+
id: config
110+
attributes:
111+
label: CRC config
112+
placeholder: |
113+
# Put `crc config view` output here
114+
description:
115+
render: shell
116+
117+
- type: textarea
118+
id: host-os
119+
attributes:
120+
label: Host Operating System
121+
placeholder: |
122+
# Put the output of `cat /etc/os-release` in case of Linux
123+
# put the output of `sw_vers` in case of Mac
124+
# Put the output of `systeminfo` in case of Windows
125+
description:
126+
render: shell
127+
validations:
128+
required: true
129+
130+
- type: textarea
131+
id: expected-behavior
132+
attributes:
133+
label: Expected behavior
134+
description: A clear and concise description of what you expected to happen.
135+
placeholder:
136+
validations:
137+
required: true
138+
139+
- type: textarea
140+
id: actual-behavior
141+
attributes:
142+
label: Actual behavior
143+
description: A clear and concise description of what actually happens.
144+
placeholder:
145+
validations:
146+
required: true
147+
148+
- type: textarea
149+
id: logs
150+
attributes:
151+
label: CRC Logs
152+
placeholder: |
153+
Before gather the logs try following if that fix your issue
154+
```bash
155+
$ crc delete -f
156+
$ crc cleanup
157+
$ crc setup
158+
$ crc start --log-level debug
159+
```
160+
Please consider posting the output of `crc start --log-level debug` on http://gist.github.com/ and post the link in the issue.
161+
description:
162+
render: shell
163+
164+
- type: textarea
165+
id: additional-context
166+
attributes:
167+
label: Additional context
168+
description: Add any other context about the problem here.
169+
placeholder:
170+

‎.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: true
2+
contact_links:
3+
- name: CRC IRC Community Chat (suitable for short, simple casual discussions)
4+
url: https://freenode.net/
5+
about: Please ask and answer questions here on 'codeready' channel.
6+
- name: CRC GitHub Discussions
7+
url: https://github.com/crc-org/crc/discussions
8+
about: CRC GitHub Discussions

‎.github/ISSUE_TEMPLATE/enhancement.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Enhancement💡
2+
description: Suggest a enhancement for CRC
3+
labels: [kind/enhancement]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
🤔 To make it easier for us to help you, please include as much useful information as possible.
10+
11+
Useful Links:
12+
- 📄 Documentation: https://crc.dev/docs/introducing/
13+
- 📝 Contributing: https://crc.dev/engineering-docs/
14+
15+
16+
- type: dropdown
17+
id: component
18+
attributes:
19+
label: Component
20+
description: Component
21+
options:
22+
- "Documentation"
23+
- "VM Drivers"
24+
- "Images"
25+
- "Daemon"
26+
- "CLI"
27+
- "Quality Engineering"
28+
validations:
29+
required: false
30+
- type: textarea
31+
id: problem
32+
attributes:
33+
label: Is your enhancement related to a problem? Please describe
34+
description: A clear and concise description of what the problem is.
35+
placeholder: I'm always frustrated when [...]
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: solution
41+
attributes:
42+
label: Describe the solution you'd like
43+
description: A clear and concise description of what you want to happen.
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
id: alternatives
49+
attributes:
50+
label: Describe alternatives you've considered
51+
description: A clear and concise description of any alternative solutions or features you've considered.
52+
53+
- type: textarea
54+
id: additional-context
55+
attributes:
56+
label: Additional context
57+
description: Add any other context or screenshots about the enhancement here.

‎.github/ISSUE_TEMPLATE/task.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Task 🔧
2+
description: Internal things, technical debt, and to-do tasks to be performed
3+
labels: [kind/task]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
### Suggesting a new task 🔧
10+
11+
🤔 To make it easier for us to help you, please include as much useful information as possible.
12+
13+
Useful Links:
14+
- 📄 Documentation: https://crc.dev/docs/introducing/
15+
- 📝 Contributing: https://crc.dev/engineering-docs/
16+
17+
- type: dropdown
18+
id: component
19+
attributes:
20+
label: Component
21+
description: Component
22+
options:
23+
- "Documentation"
24+
- "VM Drivers"
25+
- "Images"
26+
- "Daemon"
27+
- "CLI"
28+
- "Quality Engineering"
29+
validations:
30+
required: false
31+
32+
- type: textarea
33+
id: description
34+
attributes:
35+
label: Task description
36+
description: Step by step details on how to proceed with task.
37+
value: |
38+
### Description
39+
40+
41+
### Expected Behavior
42+
43+
44+
### Acceptance Criteria
45+
- [ ] AC1

0 commit comments

Comments
 (0)