From ab0c1284fbe09d084e226e474fabbfae64a4ee7f Mon Sep 17 00:00:00 2001 From: leukipp Date: Sun, 7 Dec 2025 11:46:44 +0100 Subject: [PATCH] docs: add issue templates --- .github/ISSUE_TEMPLATE/1-BUG.yaml | 117 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/2-FEATURE.yaml | 82 ++++++++++++++++++ .github/ISSUE_TEMPLATE/3-GENERAL.yaml | 82 ++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yaml | 1 + 4 files changed, 282 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/1-BUG.yaml create mode 100644 .github/ISSUE_TEMPLATE/2-FEATURE.yaml create mode 100644 .github/ISSUE_TEMPLATE/3-GENERAL.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yaml diff --git a/.github/ISSUE_TEMPLATE/1-BUG.yaml b/.github/ISSUE_TEMPLATE/1-BUG.yaml new file mode 100644 index 0000000..58dc7f9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-BUG.yaml @@ -0,0 +1,117 @@ +name: Report a bug in the application +description: I encountered a bug that was not reported before. +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + This issue form is for reporting unknown bugs only! + - [x] I promise to have read the [FAQ](https://github.com/leukipp/touchkio/blob/main/HARDWARE.md#faq) section in the hardware documentation first! 🤞 + - [x] I promise to have read the [ISSUES](https://github.com/leukipp/touchkio?tab=readme-ov-file#issues) section and know how to debug the application! 🤞 + - [x] I also swear to have searched for similar open and closed issues on [GITHUB](https://github.com/leukipp/touchkio/issues?q=is%3Aissue) first! 🤞 + - type: textarea + id: problem_description + validations: + required: true + attributes: + label: Problem description + placeholder: problem description + description: | + Describe the issue you are experiencing and how to reproduce it. + - type: markdown + attributes: + value: | + ## Details + - type: input + id: app_version + validations: + required: true + attributes: + label: What version of TouchKio is used? + placeholder: v + description: > + Can be found on the MQTT device under `Diagnostics > Version`. + - type: input + id: operating_system + validations: + required: true + attributes: + label: What operating system and version is used? + description: > + Raspberry Pi OS (Trixie), Ubuntu (24.04), etc. + - type: dropdown + id: display_server + validations: + required: true + attributes: + label: Which display server is configured on the system? + description: > + Use `loginctl show-session $(loginctl show-user $(whoami) -p Display --value) -p Type --value` to find out. + options: + - Wayland + - X11 + - Other + - type: input + id: hardware_model + validations: + required: true + attributes: + label: Which hardware model is used? + description: > + Raspberry Pi 5 (8GB RAM), Intel NUC 14 (16GB RAM), etc. + - type: input + id: screen_model + validations: + required: true + attributes: + label: Which screen model is used? + description: > + Raspberry Pi 7" Touch Display 2 (720x1280), Waveshare 8" CAPLCD (768x1024), etc. + - type: dropdown + id: screen_connection + validations: + required: true + attributes: + label: Which screen connection type is used? + description: > + Choose the connection type between your screen and the host machine. + options: + - DSI + - HDMI + - HDMI + USB + - Other + - type: markdown + attributes: + value: | + ## Diagnostics + - type: textarea + id: arguments_json + validations: + required: false + attributes: + label: Used arguments + placeholder: json arguments + description: | + Use `cat ~/.config/touchkio/Arguments.json` to get the content. + render: json + - type: textarea + id: log_file + validations: + required: false + attributes: + label: Log file + placeholder: drag-and-drop the log file or copy-and-paste the full content here + description: | + From the host machine use `scp USER@IP:~/.config/touchkio/logs/main.log main.log` to download the log file. + Alternatively, you can use `cat ~/.config/touchkio/logs/main.log` on a ssh connection to get the content. + render: txt + - type: textarea + id: additional_information + validations: + required: false + attributes: + label: Additional information + placeholder: additional information + description: | + If you have any additional information that might be useful, use this field. diff --git a/.github/ISSUE_TEMPLATE/2-FEATURE.yaml b/.github/ISSUE_TEMPLATE/2-FEATURE.yaml new file mode 100644 index 0000000..e5a23bc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-FEATURE.yaml @@ -0,0 +1,82 @@ +name: Request a new feature for the application +description: I want to request a new feature that is not yet available. +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + This issue form is for requesting new features only! + - [x] I promise to have read the [FAQ](https://github.com/leukipp/touchkio/blob/main/HARDWARE.md#faq) section in the hardware documentation first! 🤞 + - [x] I also swear to have searched for similar open and closed feature requests on [GITHUB](https://github.com/leukipp/touchkio/issues?q=is%3Aissue) first! 🤞 + - type: textarea + id: feature_description + validations: + required: true + attributes: + label: Feature description + placeholder: feature description + description: | + Describe the feature you want to request and why it would be useful for others. + - type: markdown + attributes: + value: | + ## Details + - type: input + id: app_version + validations: + required: true + attributes: + label: What version of TouchKio is used? + placeholder: v + description: > + Can be found on the MQTT device under `Diagnostics > Version`. + - type: input + id: operating_system + validations: + required: true + attributes: + label: What operating system and version is used? + description: > + Raspberry Pi OS (Trixie), Ubuntu (24.04), etc. + - type: dropdown + id: display_server + validations: + required: true + attributes: + label: Which display server is configured on the system? + description: > + Use `loginctl show-session $(loginctl show-user $(whoami) -p Display --value) -p Type --value` to find out. + options: + - Wayland + - X11 + - Other + - type: input + id: hardware_model + validations: + required: true + attributes: + label: Which hardware model is used? + description: > + Raspberry Pi 5 (8GB RAM), Intel NUC 14 (16GB RAM), etc. + - type: input + id: screen_model + validations: + required: true + attributes: + label: Which screen model is used? + description: > + Raspberry Pi 7" Touch Display 2 (720x1280), Waveshare 8" CAPLCD (768x1024), etc. + - type: dropdown + id: screen_connection + validations: + required: true + attributes: + label: Which screen connection type is used? + description: > + Choose the connection type between your screen and the host machine. + options: + - DSI + - HDMI + - HDMI + USB + - Other diff --git a/.github/ISSUE_TEMPLATE/3-GENERAL.yaml b/.github/ISSUE_TEMPLATE/3-GENERAL.yaml new file mode 100644 index 0000000..f0bfedf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-GENERAL.yaml @@ -0,0 +1,82 @@ +name: General inquiry or suggestion for the project +description: I want to ask a question or improve the documentation. +title: "[General]: " +labels: ["question"] +body: + - type: markdown + attributes: + value: | + This issue form is for general inquiries only! + - [x] I promise that the `Report a bug in the application` issue form is not suitable for my question or suggestion! 🤞 + - [x] I promise that the `Request a new feature for the application` issue form is not suitable for my question or suggestion! 🤞 + - type: textarea + id: general_comment + validations: + required: true + attributes: + label: General comment + placeholder: general comment + description: | + Ask a question, request some help, leave a general information or suggest an improvement for the documentation. + - type: markdown + attributes: + value: | + ## Details (optional) + - type: input + id: app_version + validations: + required: false + attributes: + label: What version of TouchKio is used? + placeholder: v + description: > + Can be found on the MQTT device under `Diagnostics > Version`. + - type: input + id: operating_system + validations: + required: false + attributes: + label: What operating system and version is used? + description: > + Raspberry Pi OS (Trixie), Ubuntu (24.04), etc. + - type: dropdown + id: display_server + validations: + required: false + attributes: + label: Which display server is configured on the system? + description: > + Use `loginctl show-session $(loginctl show-user $(whoami) -p Display --value) -p Type --value` to find out. + options: + - Wayland + - X11 + - Other + - type: input + id: hardware_model + validations: + required: false + attributes: + label: Which hardware model is used? + description: > + Raspberry Pi 5 (8GB RAM), Intel NUC 14 (16GB RAM), etc. + - type: input + id: screen_model + validations: + required: false + attributes: + label: Which screen model is used? + description: > + Raspberry Pi 7" Touch Display 2 (720x1280), Waveshare 8" CAPLCD (768x1024), etc. + - type: dropdown + id: screen_connection + validations: + required: false + attributes: + label: Which screen connection type is used? + description: > + Choose the connection type between your screen and the host machine. + options: + - DSI + - HDMI + - HDMI + USB + - Other diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1 @@ +blank_issues_enabled: false