changed issue templates to issue form

AlvinSchiller · Mar 1, 2024 · 7ba5a56 · 7ba5a56
1 parent 6682c5c
commit 7ba5a56
Show file tree

Hide file tree

Showing 4 changed files with 222 additions and 129 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_template.md b/.github/ISSUE_TEMPLATE/bug_template.md
@@ -1,93 +1,93 @@
----
-name: bug report
-about: use this template to report bugs
-title: "\U0001F41B | BUG SUMMARY"
-labels: bug, needs triage
----
-
-## Bug
-
-### What I did
-
-<!--
-i.e. `I installed the raspberry pi with below mentioned image and ran the installer script`
--->
-
-### What happened
-
-<!--
-i.e. `During the first run of 'apt-get install' an error was shown: 'E: Broken packages'`
--->
-
-### I expected this to happen
-
-<!--
-i.e. `I would have expected that this command would magically fix itself when it encounters and error.`
--->
-
-### Further information that might help
-
-<!--
-Please post here the output of 'tail -n 500 /var/log/syslog' or 'journalctl -u mopidy' ( Spotify edition only)
-
-i.e. `find logfiles at https://paste.ubuntu.com/p/cRS7qM8ZmP/`
--->
-
-
-## Software
-
-### Base image and version
-
-<!--
-i.e. `2019-09-26-raspbian-buster-lite.img`
-
-Otherwise the output of `cat /etc/os-release`
--->
-
-### Branch / Release
-
-<!--
-i.e. `master`
-
-the following command will help with that
-`cd /home/pi/RPi-Jukebox-RFID/ && git status | head -2`
--->
-
-### Installscript
-
-<!--
-i.e. `scripts/installscripts/install-jukebox.sh`
--->
-
-
-## Hardware
-
-### RaspberryPi version
-
-<!--
-i.e. `3 B+`
-
-Can be obtained by executing `sudo cat /sys/firmware/devicetree/base/model` on the RaspberryPi
--->
-
-### RFID Reader
-
-<!--
-i.e. `16c0:27db HXGCoLtd Keyboard`
-
-Can be found in the output of `sudo lsusb -v` when it is connected via USB.
--->
-
-### Soundcard
-
-<!--
-i.e. `0d8c:0014 C-Media Electronics, Inc. Audio Adapter (Unitek Y-247A)`
-
-Can be found in the output of `sudo lsusb -v` when it is connected via USB.
--->
-
-### Other notable hardware
-
-<!--
-i.e. post your GPIO pin settings from `RPi-Jukebox-RFID/settings/gpio_settings.ini`:
--->
+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?
diff --git a/.github/ISSUE_TEMPLATE/bug_v3.yaml b/.github/ISSUE_TEMPLATE/bug_v3.yaml
@@ -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?
diff --git a/.github/ISSUE_TEMPLATE/feature_template.md b/.github/ISSUE_TEMPLATE/feature_template.md
diff --git a/.github/ISSUE_TEMPLATE/future3.md b/.github/ISSUE_TEMPLATE/future3.md
@@ -1,19 +1,38 @@
----
-name: future3 Bug Report
-about: Use this template to report bugs for the upcoming version 3
-title: "ISSUE SUMMARY on future3"
-labels: future3, bug, needs triage
----
+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 new functionality.
 
-### Describe your problem 
+  - 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`
+    validations:
+      required: true
 
-Core, Web application ...
+  - 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.`
 
-#### What's your hardware set up? 
-
-RPi version, RFID Reader, Audio devices etc.
-
-#### If possible, try to attach logs from ... (paths from RPi)
-
-  * `~/RPi-Jukebox-RFID/shared/logs` -> General Jukebox logs
-  * `~/INSTALL-XXXXXXXXX.log` -> The logfile being generated when installing the Jukebox code
+  - 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`