From 97b37d3957720b1d2046dadf74520748cb668458 Mon Sep 17 00:00:00 2001 From: schroda <50052685+schroda@users.noreply.github.com> Date: Thu, 20 Mar 2025 00:16:03 +0100 Subject: [PATCH] Update github issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 51 -------- .github/ISSUE_TEMPLATE/bug_report.yml | 128 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 29 ----- .github/ISSUE_TEMPLATE/feature_request.yml | 41 +++++++ 4 files changed, 169 insertions(+), 80 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 10e68140..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -name: "🐞 Bug report" -title: "[Bug] " -about: "Report a bug" -labels: "bug" ---- - -**PLEASE READ THIS** - -I acknowledge that: - -- I have updated to the latest version of the app. -- I have tried the troubleshooting guide described in `README.md` -- If this is a request for adding/changing an extension it should be brought up to your extension repo. -- If this is an issue with some extension not working properly, It does work inside Mihon (Tachiyomi) as intended. -- I have searched the existing issues and this is a new ticket **NOT** a duplicate or related to another open issue -- I will fill out the title and the information in this template - -Note that the issue will be automatically closed if you do not fill out the title or requested information. - -**Delete everything up to "## Device information" if you've read and acknowledged this section** - ---- - -## Device information -- Suwayomi-WebUI version: (Example: r1234) -- Suwayomi-Server version: (Example: v1.0.0-r1438-win32) -- Server Operating System: (Example: Ubuntu 20.04) -- Server Desktop Environment: N/A or (Example: Gnome 40) -- Server JVM version: bundled with win32 or (Example: Java 8 Update 281 or OpenJDK 8u281) -- Client Operating System: -- Client Web Browser: (Example: Google Chrome 89.0.4389.82) - -## Steps to reproduce -1. First Step -2. Second Step - -### Expected behavior -Describe what should have happened. Remove this line after you are done. - -### Actual behavior -Describe what happens instead. Remove this line after you are done. - -## Other details -Describe additional details If necessary. Remove this line after you are done. - -### Video -Provide a video showcasing the issue. Remove this line after you are done. - -### Screenshots -Provide screenshots showcasing the issue. Remove this line after you are done. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..d1d260e8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,128 @@ +name: 🐞 Bug report +description: Report a bug in Suwayomi-WebUI +labels: [Bug] +body: + +- type: textarea + id: reproduce-steps + attributes: + label: Steps to reproduce + description: Provide an example of the issue. + placeholder: | + Example: + 1. First step + 2. Second step + 3. Issue here + validations: + required: true + +- type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: Explain what you should expect to happen. + placeholder: | + Example: "This should happen..." + validations: + required: true + +- type: textarea + id: actual-behavior + attributes: + label: Actual behavior + description: Explain what actually happens. + placeholder: | + Example: "This happened instead..." + validations: + required: true + +- type: input + id: suwayomi-webui-version + attributes: + label: Suwayomi-WebUI version + description: You can find your Suwayomi-WebUI version in **More → About**. + placeholder: | + Example: "r1689 STABLE | r2401 PREVIEW" + validations: + required: true + +- type: input + id: suwayomi-server-version + attributes: + label: Suwayomi-Server version + description: You can find your Suwayomi-Server version in **More → About**. + placeholder: | + Example: "v1.1.1 | v1.1.1-r1701" + validations: + required: true + +- type: input + id: client-browser + attributes: + label: Used web browser + description: The web browser which + placeholder: | + Example: "Windows 11 Pro 24H2 | Ubuntu 24.04.2 LTS" + validations: + required: true + +- type: input + id: client-os + attributes: + label: Client operating system + description: The system on which the Suwayomi-WebUI is running on + placeholder: | + Example: "Windows 11 Pro 24H2 | Ubuntu 24.04.2 LTS" + validations: + required: true + +- type: input + id: server-os + attributes: + label: Server operating system + description: The version of the browser which is used to open Suwayomi-WebUI + placeholder: | + Example: "Microsoft Edge 134.0.3124.72 (Official build) (64-Bit) | FireFox 136.0.2 (64-Bit) | Electron v35.0.2" + validations: + required: true + +- type: input + id: server-jvm-version + attributes: + label: Server JVM version + description: The java version used to run Suwayomi-Server + placeholder: | + Example: "openjdk 21.0.5 2024-10-15 LTS" + validations: + required: true + +- type: textarea + id: other-details + attributes: + label: Other details + description: The more information especially via videos and images can be provided the better + placeholder: | + Additional details and attachments. + +- type: checkboxes + id: acknowledgements + attributes: + label: Acknowledgements + description: Read this carefully, we will close and ignore your issue if you skimmed through this. + options: + - label: I have searched the existing issues and this is a new ticket, **NOT** a duplicate or related to another open or closed issue. + required: true + - label: I have checked the [ongoing preview changelog](https://github.com/Suwayomi/Suwayomi-WebUI/issues/749) and this bug has **NOT** been listed as fixed + required: true + - label: This bug is UI related and does not belong to the server. If in doubt, create the request in the [Suwayomi-Server repository](https://github.com/Suwayomi/Suwayomi-Server/issues). + required: true + - label: I have written a short but informative title (ideally less than ~100 characters). + required: true + - label: I have gone through the [Suwayomi-Server wiki](https://github.com/Suwayomi/Suwayomi-Server/wiki) and [Discord FAQ and support](https://discord.gg/DDZdqZWaHA). + required: true + - label: I have updated the Suwayomi-WebUI and Suwayomi-Server to the latest versions (**[Suwayomi-WebUI](https://github.com/suwayomi/suwayomi-webui/releases/latest)**, **[Suwayomi-Server](https://github.com/suwayomi/suwayomi-server/releases/latest)**). + required: true + - label: I have filled out all of the requested information in this form, including specific version numbers. + required: true + - label: I understand that **Suwayomi does not have or fix any extensions**, and I **will not receive help** for any issues related to sources or extensions. + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index a7bd5a40..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -name: "🌟 Feature request" -title: "[Feature Request] " -about: "Suggest a feature to improve the project" -labels: "enhancement" ---- - -**PLEASE READ THIS** - -I acknowledge that: - -- I have updated to the latest version of the app. -- I have tried the troubleshooting guide described in `README.md` -- If this is a request for adding/changing an extension it should be brought up to your extension repo. -- If this is an issue with some extension not working properly, It does work inside Mihon (Tachiyomi) as intended. -- I have searched the existing issues and this is a new ticket **NOT** a duplicate or related to another open issue -- I will fill out the title and the information in this template - -Note that the issue will be automatically closed if you do not fill out the title or requested information. - -**Delete everything up to "## What feature should be added to Suwayomi" if you've read and acknowledged this section** - ---- - -## What feature should be added to Suwayomi? -Explain What the feature is and how it should work in detail. Remove this line after you are done. - -## Why/Project's Benefit/Existing Problem -Explain why this should be added. Remove this line after you are done. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..e0e922d4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,41 @@ +name: 🌟 Feature request +description: Suggest a feature to improve Suwayomi-WebUI +labels: [Bug] +body: + + - type: textarea + id: feature-description + attributes: + label: Describe your suggested feature + description: How can Suwayomi-WebUI be improved? + placeholder: | + Example: + "It should work like this..." + validations: + required: true + + - type: textarea + id: other-details + attributes: + label: Other details + placeholder: | + Additional details and attachments. + + - type: checkboxes + id: acknowledgements + attributes: + label: Acknowledgements + description: Read this carefully, we will close and ignore your issue if you skimmed through this. + options: + - label: I have searched the existing issues and this is a new ticket, **NOT** a duplicate or related to another open or closed issue. + required: true + - label: I have checked the [ongoing preview changelog](https://github.com/Suwayomi/Suwayomi-WebUI/issues/749) and this feature is **NOT** yet listed. + required: true + - label: This feature is UI related and does not belong to the server. If in doubt, create the request in the [Suwayomi-Server repository](https://github.com/Suwayomi/Suwayomi-Server/issues). + required: true + - label: I have written a short but informative title (ideally less than ~100 characters). + required: true + - label: I have updated the Suwayomi-WebUI and Suwayomi-Server to the latest versions (**[Suwayomi-WebUI](https://github.com/suwayomi/suwayomi-webui/releases/latest)**, **[Suwayomi-Server](https://github.com/suwayomi/suwayomi-server/releases/latest)**). + required: true + - label: I have filled out all of the requested information in this form, including specific version numbers. + required: true \ No newline at end of file