diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 66412478a0..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -name: "Bug report" -about: "Create a report to help us improve" -title: "[BUG]" -labels: "kind/bug, status/need triage" -assignees: "" - ---- - -### General information - - * OS: Linux / macOS / Windows - * Hypervisor: KVM / Hyper-V / hyperkit / vfkit - * Did you run `crc setup` before starting it (Yes/No)? - * Running CRC on: Laptop / Baremetal-Server / VM - -## CRC version -```bash -# Put `crc version` output here -``` - -## CRC status -```bash -# Put `crc status --log-level debug` output here -``` - -## CRC config -```bash -# Put `crc config view` output here -``` - -## Host Operating System -```bash -# 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 -``` - -### Steps to reproduce - - 1. - 2. - 3. - 4. - -### Expected - - -### Actual - - -### Logs - -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. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..10a5121f22 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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: + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..53c29cf760 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml new file mode 100644 index 0000000000..3bf2a17134 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/task.yml b/.github/ISSUE_TEMPLATE/task.yml new file mode 100644 index 0000000000..082e7e15cd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task.yml @@ -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