Merge pull request #2311 from MiczFlor/develop

Release v2.6.0

.coveragerc

@@ -0,0 +1,4 @@
+[run]
+omit =
+    **/test/*
+    scripts/*

.flake8

@@ -4,4 +4,9 @@ ignore =
     # continuation line over-indented for visual indent
     E127,
     # continuation line under-indented for visual indent
-    E128
+    E128
+per-file-ignores =
+    # Only in __init__files ignore imported but unused
+    # Not necessary, if __all__ is declared in __init__ file
+    # https://www.python.org/dev/peps/pep-0008/#id48
+    __init__.py:F401

.github/ISSUE_TEMPLATE/bug_v2.yaml

@@ -0,0 +1,98 @@
+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.
+        * `/home/pi/phoniebox_logs/install-jukebox.sh_*.log` -> Installation log
+        * `tail -n 200 /var/log/syslog` (<= Bullseye) or `journalctl -n 200` (>= Bookworm) -> General system log
+
+        You might also want to run the analytics script:
+        * `/home/pi/RPi-Jukebox-RFID/scripts/helperscripts/Analytics_AfterInstallScript.sh`
+
+        Note: The logs may contain some personal information, You want to erase before sharing.
+
+  - 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?

.github/ISSUE_TEMPLATE/bug_v3.yaml

@@ -0,0 +1,97 @@
+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. "future3/main" or "future3/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.
+        - `~/INSTALL-XXXXXXXXX.log` -> Installation log
+        - `~/RPi-Jukebox-RFID/shared/logs/*.log` -> General Jukebox app and error logs
+          General Jukebox logs can also be found at `http://ip.of.your.box/logs/*.log`
+
+        Note: The logs may contain some personal information, You want to erase before sharing.
+
+
+  - 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?

.github/ISSUE_TEMPLATE/config.yml

@@ -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.

.github/ISSUE_TEMPLATE/feature_v3.yaml

@@ -0,0 +1,38 @@
+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.
+
+  - 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
+
+  - 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`