From 5ab5e71eaadf634dc9027a788d86ad19a2a3af6e Mon Sep 17 00:00:00 2001 From: Gauthier Roebroeck Date: Fri, 28 Jan 2022 11:47:10 +0800 Subject: [PATCH] chore: convert issue templates to forms --- .github/ISSUE_TEMPLATE/---bug-report.md | 45 ---------- .github/ISSUE_TEMPLATE/---feature-request.md | 20 ----- .github/ISSUE_TEMPLATE/config.yml | 8 ++ .github/ISSUE_TEMPLATE/report_feature.yml | 38 ++++++++ .github/ISSUE_TEMPLATE/report_issue.yml | 92 ++++++++++++++++++++ 5 files changed, 138 insertions(+), 65 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/---bug-report.md delete mode 100644 .github/ISSUE_TEMPLATE/---feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/report_feature.yml create mode 100644 .github/ISSUE_TEMPLATE/report_issue.yml diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md deleted file mode 100644 index 6d1dc430..00000000 --- a/.github/ISSUE_TEMPLATE/---bug-report.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -name: "\U0001F41E Bug report" -about: Create a report to help us improve -title: "[Bug] Short description" -labels: '' -assignees: '' - ---- - -### Komga environment -- **OS**: -- **Komga version**: -- [ ] **I am running Komga with Docker** - - Docker image tag [e.g. latest, beta]: -- [ ] **I am running Komga from the `jar`** - - Java version: -- [ ] **I have a problem in the web interface** - - Browser (with version): -- [ ] **I have a problem with an OPDS client application** - - OPDS Application (with version): -- [ ] **I have a problem with the Tachiyomi extension** - - Tachiyomi version: - - Tachiyomi extension version: - -### Describe the bug -A clear and concise description of what the bug is. - -### Steps to reproduce -1. Go to '...' -2. Click on '....' - -### Expected behavior -A clear and concise description of what you expected to happen. - -### Actual behavior -What happened instead. - -### Additional context -Add any other context about the problem here. - -### Screenshots -If applicable, add screenshots to help explain your problem. - -### Log file -If applicable, add an excerpt of the log file (max 20 lines) _AND_ attach the complete log file or a link to a gist/pastebin containing the log file ([where to find the logs](https://komga.org/faq/#where-can-i-find-the-log-files)). diff --git a/.github/ISSUE_TEMPLATE/---feature-request.md b/.github/ISSUE_TEMPLATE/---feature-request.md deleted file mode 100644 index 32fc7ad7..00000000 --- a/.github/ISSUE_TEMPLATE/---feature-request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: "\U0001F31F Feature request" -about: Suggest an idea for this project -title: "[Feature Request] Short description" -labels: '' -assignees: '' - ---- - -### Is your feature request related to a problem? Please describe. -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -### Describe the solution you'd like -A clear and concise description of what you want to happen. - -### Describe alternatives you've considered or other apps that can do what you want -A clear and concise description of any alternative solutions or features you've considered. - -### Additional context -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..3047f32d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: 🖥️ Komga website + url: https://komga.org/faq/ + about: Guides, troubleshooting, and answers to common questions + - name: ⚠️ Tachiyomi extension + url: https://github.com/tachiyomiorg/tachiyomi-extensions/issues/new/choose + about: Issues and requests about the Tachiyomi extension should be opened in the tachiyomi-extensions repository instead diff --git a/.github/ISSUE_TEMPLATE/report_feature.yml b/.github/ISSUE_TEMPLATE/report_feature.yml new file mode 100644 index 00000000..6dd2cc33 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/report_feature.yml @@ -0,0 +1,38 @@ +name: ⭐ Feature request +description: Suggest a feature to improve Komga +labels: + - enhancement +body: + + - type: textarea + id: feature-description + attributes: + label: Describe your suggested feature + description: How can Komga 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 issue. + required: true + - label: I have written a short but informative title. + required: true + - label: I have updated the app to the latest version. + required: true + - label: I will fill out all of the requested information in this form. + required: true diff --git a/.github/ISSUE_TEMPLATE/report_issue.yml b/.github/ISSUE_TEMPLATE/report_issue.yml new file mode 100644 index 00000000..9f1d5281 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/report_issue.yml @@ -0,0 +1,92 @@ +name: 🐞 Issue report +description: Report an issue in Komga +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: textarea + id: logfile + attributes: + label: Logs + description: | + If applicable, add an excerpt of the log file (max 20 lines) _AND_ attach the complete log file or a link to a gist/pastebin containing the log file ([where to find the logs](https://komga.org/faq/#where-can-i-find-the-log-files)). + placeholder: | + You can paste the logs in pure text or upload it as an attachment. + + - type: input + id: komga-version + attributes: + label: Komga version + description: You can find your Komga version at the bottom of the side bar. + placeholder: | + Example: "0.143.0" + validations: + required: true + + - type: input + id: operating-system + attributes: + label: Operating system + placeholder: | + Example: "Windows 11" + 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 issue. + required: true + - label: I have written a short but informative title. + required: true + - label: I have checked the [FAQ](https://komga.org/faq/). + required: true + - label: I have updated the app to the latest version. + required: true + - label: I will fill out all of the requested information in this form. + required: true