mirror of
https://github.com/cmclark00/retro-imager.git
synced 2025-05-18 07:55:21 +01:00
Update issue creation templates (#823)
Rather than providing a free text template, as we've done so far, introduce a form to more stringently require information that we need to debug the problem.
This commit is contained in:
Tom Dewey
GitHub
parent
6a19fa1938
commit
75eb08c2a0
4 changed files with 167 additions and 48 deletions
109
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
109
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
|
|
@ -0,0 +1,109 @@
|
|||
name: Bug Report
|
||||
description: Thanks for the report!
|
||||
title: "[BUG]: "
|
||||
labels: ["bug", "triage"]
|
||||
projects: []
|
||||
assignees: []
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this bug report!
|
||||
- type: textarea
|
||||
id: what-happened
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: Also tell us, what did you expect to happen?
|
||||
placeholder: Tell us what you see!
|
||||
value: "A bug happened!"
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: version
|
||||
attributes:
|
||||
label: Version
|
||||
description: What version of our software are you running?
|
||||
options:
|
||||
- 1.8.5 (Default)
|
||||
- 1.8.4
|
||||
- 1.8.3
|
||||
- 1.8.2
|
||||
- 1.8.1
|
||||
- < 1.8.0
|
||||
default: 0
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: host-os
|
||||
attributes:
|
||||
label: What host operating system were you using?
|
||||
multiple: false
|
||||
options:
|
||||
- Windows
|
||||
- macOS
|
||||
- Debian and derivatives (eg Ubuntu)
|
||||
- Other Linux environment
|
||||
- Other non-Linux environment
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: host-os-version
|
||||
attributes:
|
||||
label: Host OS Version
|
||||
description: What version of your host OS were you using?
|
||||
placeholder: ex 11H2, 10.4, Catalina, 22.04
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: target-os-version
|
||||
attributes:
|
||||
label: Selected OS
|
||||
description: Which OS did you select to write? (For custom images, just write 'Custom')
|
||||
placeholder: ex Raspberry Pi OS Bookworm 64-bit, Ubuntu 23.10, LibreELEC
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: raspberry-pi-device
|
||||
attributes:
|
||||
label: Which Raspberry Pi Device are you using?
|
||||
multiple: false
|
||||
options:
|
||||
- Raspberry Pi 5
|
||||
- Raspberry Pi 4B, 400, and Compute Modules 4, 4S
|
||||
- Raspberry Pi Zero 2 W
|
||||
- Raspberry Pi 3B, 3A+, 3B+, and Compute Module 3, 3+
|
||||
- Raspberry Pi Zero, Zero W, Zero WH
|
||||
- Raspberry Pi A, B, A+, B+, and Compute Module 1
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: storage-device
|
||||
attributes:
|
||||
label: What kind of storage device are you using?
|
||||
multiple: false
|
||||
options:
|
||||
- microSD Card in an internal reader
|
||||
- microSD Card in a USB reader
|
||||
- Integrated eMMC
|
||||
- NVMe SSD via Raspberry Pi M.2 HAT+
|
||||
- NVMe SSD via Third-party PCIe attachment
|
||||
- USB Pen Drive
|
||||
- USB SSD
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
- type: checkboxes
|
||||
id: terms
|
||||
attributes:
|
||||
label: OS Customisation
|
||||
description: Were you using OS Customisation when you enountered the bug?
|
||||
options:
|
||||
- label: Yes, I was using OS Customisation when the bug occurred.
|
||||
required: false
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Relevant log output
|
||||
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
|
||||
render: shell
|
||||
|
||||
29
.github/ISSUE_TEMPLATE/bug_report.md
vendored
29
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
|
@ -1,29 +0,0 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Thanks for the report!
|
||||
title: "[BUG]"
|
||||
labels: bug
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Include steps to allow us to reproduce the error. Include your host OS, and the version of Raspberry Pi Imager.
|
||||
|
||||
**Expected behaviour**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Screenshots or video**
|
||||
If applicable, add screenshots or a video to help explain your problem.
|
||||
|
||||
**Desktop (please complete the following information):**
|
||||
- OS: [e.g. macOS 14, Windows 11, Ubuntu Server 22.04]
|
||||
|
||||
**The name of the OS you are trying to write**
|
||||
|
||||
**Are you using OS Customisation?**
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
58
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
Normal file
58
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
name: Feature Request
|
||||
description: What would you like to see from rpi-imager?
|
||||
title: "[FEATURE]: "
|
||||
labels: ["enhancement", "triage"]
|
||||
projects: []
|
||||
assignees: []
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this feature request!
|
||||
- type: textarea
|
||||
id: what-could-be-better
|
||||
attributes:
|
||||
label: Is your feature request related to a problem? Please describe.
|
||||
description: A description of the issue you're facing that requires this feature.
|
||||
placeholder: Ex. I never notice when OS writing has finished...
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: what-do-you-want-to-see
|
||||
attributes:
|
||||
label: Describe the solution you would like to see implemented
|
||||
description: A clear and concise description of what you want to happen.
|
||||
placeholder: Ex. rpi-imager should initiate a confetti shower when writing is finished
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: what-else-did-you-consider
|
||||
attributes:
|
||||
label: Describe alternatives you've considered
|
||||
description: A clear and concise description of any alternative solutions or features you've considered.
|
||||
placeholder: Ex. Alert sirens, SMS notifications, hiring a sky writer
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: anything-else
|
||||
attributes:
|
||||
label: Additional context
|
||||
description: Add any other context or screenshots about the feature request here.
|
||||
placeholder: Ex. Must be large confetti to make it easier to clean up
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: version
|
||||
attributes:
|
||||
label: Version
|
||||
description: What version of our software did you last run?
|
||||
options:
|
||||
- 1.8.5 (Default)
|
||||
- 1.8.4
|
||||
- 1.8.3
|
||||
- 1.8.2
|
||||
- 1.8.1
|
||||
- < 1.8.0
|
||||
default: 0
|
||||
validations:
|
||||
required: true
|
||||
19
.github/ISSUE_TEMPLATE/feature_request.md
vendored
19
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
|
@ -1,19 +0,0 @@
|
|||
---
|
||||
name: Feature request
|
||||
about: What would you like to see from rpi-imager?
|
||||
title: "[FEATURE]"
|
||||
labels: enhancement
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
Loading…
Add table
Add a link
Reference in a new issue