From 5d915f11ffee7192d5fcb1e8f3c912b0abb06503 Mon Sep 17 00:00:00 2001 From: Aaron Liu Date: Tue, 24 Feb 2026 16:40:38 +0800 Subject: [PATCH] misc: add more issue templates --- .github/DISCUSSION_TEMPLATE/general.yml | 19 +++ .github/DISCUSSION_TEMPLATE/ideas.yml | 35 ++++++ .github/DISCUSSION_TEMPLATE/q-a.yml | 28 +++++ .github/ISSUE_TEMPLATE/bug_report.yml | 150 +++++++++++++----------- .github/ISSUE_TEMPLATE/config.yml | 4 +- 5 files changed, 164 insertions(+), 72 deletions(-) create mode 100644 .github/DISCUSSION_TEMPLATE/general.yml create mode 100644 .github/DISCUSSION_TEMPLATE/ideas.yml create mode 100644 .github/DISCUSSION_TEMPLATE/q-a.yml diff --git a/.github/DISCUSSION_TEMPLATE/general.yml b/.github/DISCUSSION_TEMPLATE/general.yml new file mode 100644 index 00000000..441d2799 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/general.yml @@ -0,0 +1,19 @@ +title: "General Discussion" +body: + - type: checkboxes + attributes: + label: Self Checks + description: "To make sure we get to you in time, please check the following :)" + options: + - label: I have searched for existing issues [search for existing issues](https://github.com/cloudreve/cloudreve/issues), including closed ones. + required: true + - label: I confirm that I am using English to submit this report, otherwise it will be closed. / 请使用英语提交，否则会被关闭。 + required: true + - label: "Please do not modify this template :) and fill in all the required fields." + required: true + - type: textarea + attributes: + label: Content + placeholder: Please describe the content you would like to discuss. + validations: + required: true diff --git a/.github/DISCUSSION_TEMPLATE/ideas.yml b/.github/DISCUSSION_TEMPLATE/ideas.yml new file mode 100644 index 00000000..1639fd0c --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/ideas.yml @@ -0,0 +1,35 @@ +title: Suggestions for New Features +body: + - type: checkboxes + attributes: + label: Self Checks + description: "To make sure we get to you in time, please check the following :)" + options: + - label: I have searched for existing issues [search for existing issues](https://github.com/cloudreve/cloudreve/issues), including closed ones. + required: true + - label: I confirm that I am using English to submit this report, otherwise it will be closed. / 请使用英语提交，否则会被关闭。 + required: true + - label: "Please do not modify this template :) and fill in all the required fields." + required: true + - type: textarea + attributes: + label: 1. Is this request related to a challenge you're experiencing? Tell me about your story. + placeholder: Please describe the specific scenario or problem you're facing as clearly as possible. For instance "I was trying to use [feature] for [specific task], and [what happened]... It was frustrating because...." + validations: + required: true + - type: textarea + attributes: + label: 2. Additional context or comments + placeholder: (Any other information, comments, documentations, links, or screenshots that would provide more clarity. This is the place to add anything else not covered above.) + validations: + required: false + - type: checkboxes + attributes: + label: 3. Can you help us with this feature? + description: Let us know! This is not a commitment, but a starting point for collaboration. + options: + - label: I am interested in contributing to this feature. + required: false + - type: markdown + attributes: + value: Please limit one request per issue. diff --git a/.github/DISCUSSION_TEMPLATE/q-a.yml b/.github/DISCUSSION_TEMPLATE/q-a.yml new file mode 100644 index 00000000..f4e626a6 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/q-a.yml @@ -0,0 +1,28 @@ +title: "Q&A" +body: + - type: checkboxes + attributes: + label: Self Checks + description: "To make sure we get to you in time, please check the following :)" + options: + - label: I have searched for existing issues [search for existing issues](https://github.com/cloudreve/cloudreve/issues), including closed ones. + required: true + - label: I confirm that I am using English to submit this report, otherwise it will be closed. / 请使用英语提交，否则会被关闭。 + required: true + - label: "Please do not modify this template :) and fill in all the required fields." + required: true + - type: textarea + attributes: + label: 1. Is this request related to a challenge you're experiencing? Tell me about your story. + placeholder: Please describe the specific scenario or problem you're facing as clearly as possible. For instance "I was trying to use [feature] for [specific task], and [what happened]... It was frustrating because...." + validations: + required: true + - type: textarea + attributes: + label: 2. Additional context or comments + placeholder: (Any other information, comments, documentations, links, or screenshots that would provide more clarity. This is the place to add anything else not covered above.) + validations: + required: false + - type: markdown + attributes: + value: Please limit one request per issue. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 155ef06f..d85b7cd9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,81 +1,91 @@ name: "🕷️ Bug report" description: Report errors or unexpected behavior labels: + - bug +body: + - type: checkboxes + attributes: + label: Self Checks + description: "To make sure we get to you in time, please check the following :)" + options: + - label: I have read the [Contributing Guide](https://docs.cloudreve.org/api/contributing) and [Language Policy](https://github.com/cloudreve/cloudreve/discussions/3335). + required: true + - label: This is only for bug report, if you would like to ask a question, please head to [Discussions](https://github.com/cloudreve/cloudreve/discussions). + required: true + - label: I have searched for existing issues [search for existing issues](https://github.com/cloudreve/cloudreve/issues), including closed ones. + required: true + - label: I confirm that I am using English to submit this report, otherwise it will be closed. / 请使用英语提交，否则会被关闭。 + required: true + - label: "Please do not modify this template :) and fill in all the required fields." + required: true -- bug - body: -- type: checkboxes - attributes: - label: Self Checks - description: "To make sure we get to you in time, please check the following :)" - options: - label: I have read the [Contributing Guide](https://docs.cloudreve.org/api/contributing) and [Language Policy](https://github.com/cloudreve/cloudreve/discussions/3335). - required: true - label: This is only for bug report, if you would like to ask a question, please head to [Discussions](https://github.com/cloudreve/cloudreve/discussions). - required: true - label: I have searched for existing issues [search for existing issues](https://github.com/cloudreve/cloudreve/issues), including closed ones. - required: true - label: I confirm that I am using English to submit this report, otherwise it will be closed. / 请使用英语提交，否则会被关闭。 - required: true - label: "Please do not modify this template :) and fill in all the required fields." - required: true + - type: input + attributes: + label: Cloudreve version + description: e.g. 4.14.0 + validations: + required: true -- type: input - attributes: - label: Cloudreve version - description: e.g. 4.14.0 - validations: - required: true + - type: dropdown + attributes: + label: Pro or Community Edition + description: What version of Cloudreve are you using? + multiple: true + options: + - Pro + - Community (Open Source) + validations: + required: true -- type: dropdown - attributes: - label: Pro or Community Edition - description: What version of Cloudreve are you using? - multiple: true - options: - Pro - Community (Open Source) - validations: - required: true + - type: dropdown + attributes: + label: Database type + description: What database are you using? + multiple: true + options: + - MySQL + - PostgreSQL + - SQLite + - I don't know + validations: + required: true -- type: dropdown - attributes: - label: Database type - description: What database are you using? - multiple: true - options: - MySQL - PostgreSQL - SQLite - I don't know - validations: - required: true + - type: input + attributes: + label: Browser and operating system + description: What browser and operating system are you using? + placeholder: Example: Chrome 123.0.0 on macOS 14.0.0 + validations: + required: false -- type: input - attributes: - label: Browser and operating system - description: What browser and operating system are you using? - placeholder: Example: Chrome 123.0.0 on macOS 14.0.0 - validations: - required: false + - type: textarea + attributes: + label: Steps to reproduce + description: We highly suggest including screenshots and a bug report log. Please use the right markdown syntax for code blocks. + placeholder: Having detailed steps helps us reproduce the bug. If you have logs, please use fenced code blocks (triple backticks ```) to format them. + validations: + required: true -- type: textarea - attributes: - label: Steps to reproduce - description: We highly suggest including screenshots and a bug report log. Please use the right markdown syntax for code blocks. - placeholder: Having detailed steps helps us reproduce the bug. If you have logs, please use fenced code blocks (triple backticks ```) to format them. - validations: - required: true + - type: textarea + attributes: + label: ✔️ Expected Behavior + description: Describe what you expected to happen. + placeholder: What were you expecting? Please do not copy and paste the steps to reproduce here. + validations: + required: true -- type: textarea - attributes: - label: ✔️ Expected Behavior - description: Describe what you expected to happen. - placeholder: What were you expecting? Please do not copy and paste the steps to reproduce here. - validations: - required: true + - type: textarea + attributes: + label: ❌ Actual Behavior + description: Describe what actually happened. + placeholder: What happened instead? Please do not copy and paste the steps to reproduce here. + validations: + required: false -- type: textarea - attributes: - label: ❌ Actual Behavior - description: Describe what actually happened. - placeholder: What happened instead? Please do not copy and paste the steps to reproduce here. - validations: - required: false - -- type: input - attributes: - label: Addition context information - description: Provide any additional context information that might be helpful. - placeholder: Any additional information that might be helpful. - validations: - required: false + - type: input + attributes: + label: Addition context information + description: Provide any additional context information that might be helpful. + placeholder: Any additional information that might be helpful. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index d85a227a..71d67164 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,9 +1,9 @@ blank_issues_enabled: false contact_links: - - name: "📱 iOS/iPadOS related issues" + - name: "\U0001F4F1 iOS/iPadOS related issues" url: "hhttps://github.com/cloudreve/ios-feedback/issues/new" about: Report issues related to the official iOS/iPadOS client. - - name: "🖥️ Desktop client related issues" + - name: "\U0001F5A5 Desktop client related issues" url: "https://github.com/cloudreve/desktop/issues/new" about: Report issues related to the official desktop client. - name: "\U0001F4AC Documentation Issues"