Skip to content

Commit

Permalink
update to Issue Form templates
Browse files Browse the repository at this point in the history
  • Loading branch information
AlvinSchiller committed Feb 20, 2024
1 parent c89b6fc commit 1b9876c
Show file tree
Hide file tree
Showing 8 changed files with 260 additions and 133 deletions.
93 changes: 93 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
name: 🐛 Bug Report v2
description: use this template to report bugs for version 2
title: "🐛 | "
labels: ["bug", "legacy_v2", "needs triage"]
body:
- type: markdown
attributes:
value: >
Please fill out the form to provide essential information to your problem.
This will help us to faster figure out the root cause.
- type: input
id: version
attributes:
label: Version
description: |
What version do you use?
See the "info" page in the Web App or the "settings/version" file.
placeholder: e.g. "2.5.0" or "2.6.0-alpha"
validations:
required: true

- type: input
id: branch
attributes:
label: Branch
description: |
What branch did you install from?
See the "info" page in the Web App or the "settings/version" file.
placeholder: e.g. "master" or "develop"
validations:
required: true

- type: input
id: os
attributes:
label: OS
description: |
What Operation System and Version do you use?
See `cat /etc/os-release`
placeholder: e.g. "Raspberry Pi OS Bullseye lite - 32bit"
validations:
required: true

- type: input
id: pi-model
attributes:
label: Pi model
description: |
Which Raspberry Pi model do you use?
placeholder: e.g. "3 B+", "Zero 2"
validations:
required: true

- type: textarea
id: hardware
attributes:
label: Hardware
description: |
What's your hardware set up?
e.g. Rfid Reader, SoundCards, ...
- type: textarea
id: what-happened
attributes:
label: What happened?
description: |
What you did, what you expected and what happened instead?
validations:
required: true

- type: textarea
id: logs
attributes:
label: Logs
description: |
Please provide the logs after the problem occured.
`tail -n 200 /var/log/syslog` (<= Bullseye) or `journalctl -n 200` (>= Bookworm)
render: shell

- type: textarea
id: config
attributes:
label: Configuration
description: |
Please provide the configuration if its related to the problem
e.g. "mpd.conf", "gpio_settings.ini", ...
- type: textarea
id: more
attributes:
label: More info
description: Anything more you want to share?
93 changes: 0 additions & 93 deletions .github/ISSUE_TEMPLATE/bug_template.md

This file was deleted.

94 changes: 94 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_v3.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
name: 🐛 Bug Report v3
description: use this template to report bugs for version 3
title: "🐛 | "
labels: ["bug", "future3", "needs triage"]
body:
- type: markdown
attributes:
value: >
Please fill out the form to provide essential information to your problem.
This will help us to faster figure out the root cause.
- type: input
id: version
attributes:
label: Version
description: |
What version do you use?
See the "settings" page in the Web App or the "src/jukebox/jukebox/version.py" file.
placeholder: e.g. "3.5.0" or "3.6.0-alpha"
validations:
required: true

- type: input
id: branch
attributes:
label: Branch
description: |
What branch did you install from?
See the "settings" page in the Web App or the "src/jukebox/jukebox/version.py" file.
placeholder: e.g. "main" or "develop"
validations:
required: true

- type: input
id: os
attributes:
label: OS
description: |
What Operation System and Version do you use?
See `cat /etc/os-release`
placeholder: e.g. "Raspberry Pi OS Bullseye lite - 32bit"
validations:
required: true

- type: input
id: pi-model
attributes:
label: Pi model
description: |
Which Raspberry Pi model do you use?
placeholder: e.g. "3 B+", "Zero 2"
validations:
required: true

- type: textarea
id: hardware
attributes:
label: Hardware
description: |
What's your hardware set up?
e.g. Rfid Reader, SoundCards, ...
- type: textarea
id: what-happened
attributes:
label: What happened?
description: |
What you did, what you expected and what happened instead?
validations:
required: true

- type: textarea
id: logs
attributes:
label: Logs
description: |
Please provide the logs after the problem occured.
`~/RPi-Jukebox-RFID/shared/logs/app.log` -> General Jukebox app logs
`~/RPi-Jukebox-RFID/shared/logs/error.log` -> General Jukebox error logs
`~/INSTALL-XXXXXXXXX.log` -> The logfile being generated when installing the Jukebox code
- type: textarea
id: config
attributes:
label: Configuration
description: |
Please provide the configuration if its related to the problem
e.g. "mpd.conf", "jukebox.yaml", ...
- type: textarea
id: more
attributes:
label: More info
description: Anything more you want to share?
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ contact_links:
url: https://github.com/MiczFlor/RPi-Jukebox-RFID/discussions/new?category=q-a
about: This issue tracker is not for support questions. Please refer to our Discussions.
- name: 💬 Chat
url: https://matrix.to/#/#phoniebox_community:gitter.im
url: https://matrix.to/#/#phoniebox_community:matrix.org
about: Want to discuss with others? Check out our chat.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: 🚀 Feature Request v2
description: use this template to propose feature requests for version 2
title: "🚀 | "
labels: ["enhancement", "legacy_v2"]
body:
- type: markdown
attributes:
value: >
Please describe your feature request.
- type: textarea
id: feature
attributes:
label: Feature
description: |
What functionality would you like to see in your phoniebox?
placeholder: |
e.g. `I would love to cook my breakfast eggs with the help of our phoniebox`
- type: textarea
id: perspective
attributes:
label: User perspective
description: |
How do you envision the feature to work from a users perspective?
placeholder: |
e.g. `In the mornings when I stumble to the bathroom, I want the phoniebox to react on the RFID chip injected under the skin of my right hip. I envision it to walk to the kitchen, get the eggs and a pot out, and start the cooking of the eggs on the stove.`
- type: textarea
id: further-info
attributes:
label: Further information
description: |
Further information that might help.
placeholder: |
e.g. `The stove is operated with cooking gas, so the implemenation has to make sure the stove is handled with the greatest possible care`
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_template.md

This file was deleted.

36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_v3.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: 🚀 Feature Request v3
description: use this template to propose feature requests for version 3
title: "🚀 | "
labels: ["enhancement", "future3"]
body:
- type: markdown
attributes:
value: >
Please describe your feature request.
- type: textarea
id: feature
attributes:
label: Feature
description: |
What functionality would you like to see in your phoniebox?
placeholder: |
e.g. `I would love to cook my breakfast eggs with the help of our phoniebox`
- type: textarea
id: perspective
attributes:
label: User perspective
description: |
How do you envision the feature to work from a users perspective?
placeholder: |
e.g. `In the mornings when I stumble to the bathroom, I want the phoniebox to react on the RFID chip injected under the skin of my right hip. I envision it to walk to the kitchen, get the eggs and a pot out, and start the cooking of the eggs on the stove.`
- type: textarea
id: further-info
attributes:
label: Further information
description: |
Further information that might help.
placeholder: |
e.g. `The stove is operated with cooking gas, so the implemenation has to make sure the stove is handled with the greatest possible care`
Loading

0 comments on commit 1b9876c

Please sign in to comment.