Skip to content

Commit

Permalink
chore : Update CRC GitHub issue template to be more interactive
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
rohanKanojia authored and gbraad committed Dec 9, 2024
1 parent b156876 commit d1fdbab
Show file tree
Hide file tree
Showing 5 changed files with 277 additions and 62 deletions.
62 changes: 0 additions & 62 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

170 changes: 170 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
name: Bug report 🐞
description: Report a bug
labels: [kind/bug]

body:
- type: markdown
attributes:
value: |
### Creating a new Bug 🐞
🔍 Before opening a new issue please search existing issues at https://github.com/crc-org/crc/issues
🤔 To make it easier for us to help you, please include as much useful information as possible.
Useful Links:
- 📄 Documentation: https://crc.dev/docs/introducing/
- 📝 Contributing: https://crc.dev/engineering-docs/
- type: textarea
id: general-info
attributes:
label: General information
description: A clear and concise description of what the bug is.
placeholder: Describe the bug
validations:
required: true

- type: dropdown
id: os
attributes:
label: Operating System
description: Which Operating System are you running CRC on?
multiple: false
options:
- Linux
- macOS
- Windows
validations:
required: true

- type: dropdown
id: hypervisor
attributes:
label: Hypervisor
description: Which Operating System are you running CRC on?
multiple: false
options:
- KVM
- Hyper-V
- hyperkit
- vfkit
validations:
required: true

- type: dropdown
id: crcsetup
attributes:
label: Did you run `crc setup` before `crc start`?
description: Did you run `crc setup` before starting it ?
multiple: false
options:
- 'yes'
- 'no'
validations:
required: true

- type: dropdown
id: running-on
attributes:
label: Running on
description: Running CRC on
multiple: false
options:
- Laptop
- Baremetal-Server
- VM
validations:
required: true

- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: What are the steps to reproduce this bug ?
placeholder: |
1. Do '...'
2. See error
validations:
required: true

- type: textarea
id: version
attributes:
label: CRC version
placeholder: |
# Put `crc version` output here
description:
render: shell

- type: textarea
id: status
attributes:
label: CRC status
placeholder: |
# Put `crc status --log-level debug` output here
description:
render: shell

- type: textarea
id: config
attributes:
label: CRC config
placeholder: |
# Put `crc config view` output here
description:
render: shell

- type: textarea
id: host-os
attributes:
label: Host Operating System
placeholder: |
# Put the output of `cat /etc/os-release` in case of Linux
# put the output of `sw_vers` in case of Mac
# Put the output of `systeminfo` in case of Windows
description:
render: shell
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
placeholder:
validations:
required: true

- type: textarea
id: actual-behavior
attributes:
label: Actual behavior
description: A clear and concise description of what actually happens.
placeholder:
validations:
required: true

- type: textarea
id: logs
attributes:
label: CRC Logs
placeholder: |
Before gather the logs try following if that fix your issue
```bash
$ crc delete -f
$ crc cleanup
$ crc setup
$ crc start --log-level debug
```
Please consider posting the output of `crc start --log-level debug` on http://gist.github.com/ and post the link in the issue.
description:
render: shell

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context about the problem here.
placeholder:

5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: CRC GitHub Discussions
url: https://github.com/crc-org/crc/discussions
about: CRC GitHub Discussions
57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Enhancement💡
description: Suggest a enhancement for CRC
labels: [kind/enhancement]

body:
- type: markdown
attributes:
value: |
🤔 To make it easier for us to help you, please include as much useful information as possible.
Useful Links:
- 📄 Documentation: https://crc.dev/docs/introducing/
- 📝 Contributing: https://crc.dev/engineering-docs/
- type: dropdown
id: component
attributes:
label: Component
description: Component
options:
- "Documentation"
- "VM Drivers"
- "Images"
- "Daemon"
- "CLI"
- "Quality Engineering"
validations:
required: false
- type: textarea
id: problem
attributes:
label: Is your enhancement related to a problem? Please describe
description: A clear and concise description of what the problem is.
placeholder: I'm always frustrated when [...]
validations:
required: true

- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context or screenshots about the enhancement here.
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Task 🔧
description: Internal things, technical debt, and to-do tasks to be performed
labels: [kind/task]

body:
- type: markdown
attributes:
value: |
### Suggesting a new task 🔧
🤔 To make it easier for us to help you, please include as much useful information as possible.
Useful Links:
- 📄 Documentation: https://crc.dev/docs/introducing/
- 📝 Contributing: https://crc.dev/engineering-docs/
- type: dropdown
id: component
attributes:
label: Component
description: Component
options:
- "Documentation"
- "VM Drivers"
- "Images"
- "Daemon"
- "CLI"
- "Quality Engineering"
validations:
required: false

- type: textarea
id: description
attributes:
label: Task description
description: Step by step details on how to proceed with task.
value: |
### Description
### Expected Behavior
### Acceptance Criteria
- [ ] AC1

0 comments on commit d1fdbab

Please sign in to comment.