From 45d0b455b491b98c54ce8a76af4b8240e62adc2d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=98=BF=E8=8F=9C=20Cai?= Date: Fri, 11 Oct 2024 19:09:17 +0800 Subject: [PATCH] =?UTF-8?q?chore(ci):=20=E5=A2=9E=E5=BC=BAissue=E7=9A=84`l?= =?UTF-8?q?abel`=E5=88=86=E7=B1=BB=E5=92=8C`template`=E7=9A=84=E6=8F=90?= =?UTF-8?q?=E7=A4=BA=20(#945)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * chore(ci): 增强issue的`label`分类和`template`的提示 * chore: 增强图标 * 更新文档issue的label匹配 * 统一version的 placeholder * 更新排序和单词拼写错误 * 统一格式 --- .../{bug_report.yml => 1.bug_report.yml} | 43 +++++++++++----- ...ture_request.yml => 2.feature_request.yml} | 20 +++++--- ...dback.yml => 3.documentation_feedback.yml} | 10 +++- ...ent_feedback.yml => 5.client_feedback.yml} | 27 +++++++--- ...eport.yml => 6.vscode_plugin_feedback.yml} | 49 ++++++++++++------- .github/ISSUE_TEMPLATE/other.md | 9 ---- .github/ISSUE_TEMPLATE/other_feedback.yml | 16 ++++++ 7 files changed, 117 insertions(+), 57 deletions(-) rename .github/ISSUE_TEMPLATE/{bug_report.yml => 1.bug_report.yml} (54%) rename .github/ISSUE_TEMPLATE/{feature_request.yml => 2.feature_request.yml} (71%) rename .github/ISSUE_TEMPLATE/{documentation_feedback.yml => 3.documentation_feedback.yml} (88%) rename .github/ISSUE_TEMPLATE/{client_feedback.yml => 5.client_feedback.yml} (64%) rename .github/ISSUE_TEMPLATE/{vscode_plugin_report.yml => 6.vscode_plugin_feedback.yml} (59%) delete mode 100644 .github/ISSUE_TEMPLATE/other.md create mode 100644 .github/ISSUE_TEMPLATE/other_feedback.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/1.bug_report.yml similarity index 54% rename from .github/ISSUE_TEMPLATE/bug_report.yml rename to .github/ISSUE_TEMPLATE/1.bug_report.yml index 8e4f61264..f319b6413 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/1.bug_report.yml @@ -1,34 +1,50 @@ name: 🐞 Bug Report description: Report a bug -title: '[Bug Report]' -labels: [bug] +title: "[Bug Report]" +labels: [🐞bug, pending-no-confirmed] body: - type: markdown attributes: - value: | - Thank you for taking the time to report this bug. + value: Thank you for taking the time to report this bug. + - type: checkboxes id: prerequisites attributes: label: Prerequisites - description: 'Before submitting the issue, ensure the following:' + description: "Before submitting the issue, ensure the following:" options: - label: There isn't an existing issue that reports the same bug to avoid duplicates. - - label: The provided information offers a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug. - - label: For Q&A, please open a [GitHub Discussion](https://github.com/Tencent/cherry-markdown/discussions) instead. - - type: textarea - id: bug-description + - label: | + The provided information offers a [minimal reproducible example](https://github.com/Tencent/cherry-markdown/tree/main/examples) of the bug + ([Why create a Minimal, Reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example)). + - label: | + For [Q&A](https://github.com/Tencent/cherry-markdown/discussions/categories/q-a), + please open a [GitHub Discussion](https://github.com/Tencent/cherry-markdown/discussions) instead. + + - type: input + id: version attributes: - label: Describe the Bug - description: Provide a clear and concise description of the bug. + label: Version + description: Providing the current version of cherry-markdown that will generate bugs. + placeholder: "v1.0.0" validations: required: true + - type: input id: reproduction attributes: - label: Reproduction Steps + label: Reproduction Link description: A [minimal reproduction](https://github.com/Tencent/cherry-markdown/tree/main/examples) is **required**. It helps us resolve your issue faster and more effectively. - placeholder: Reproduction Steps + placeholder: Reproduction Link + + - type: textarea + id: bug-description + attributes: + label: Describe the Bug + description: Provide a clear and concise description of the bug. + validations: + required: true + - type: textarea id: system-info attributes: @@ -36,6 +52,7 @@ body: description: Output of `npx envinfo --system --binaries --browsers` render: Shell placeholder: System, Binaries, Browsers + - type: dropdown id: help-us attributes: diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/2.feature_request.yml similarity index 71% rename from .github/ISSUE_TEMPLATE/feature_request.yml rename to .github/ISSUE_TEMPLATE/2.feature_request.yml index f2206f3d5..c00ad3dd9 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/2.feature_request.yml @@ -1,37 +1,41 @@ -name: 🚀 New feature proposal +name: 🚀 New Feature Request description: Suggest an idea for this project -title: '[Feature Request]' -labels: [enhancement] +title: "[Feature Request]" +labels: [🚀enhancement, pending-no-confirmed] body: - type: markdown attributes: - value: | - Thank you for your interest in the project and taking the time to fill out this feature report! + value: Thank you for your interest in the project and taking the time to fill out this feature report. + - type: checkboxes id: prerequisites attributes: label: Prerequisites - description: 'Before submitting the issue, ensure the following:' + description: "Before submitting the issue, ensure the following:" options: - label: There isn't an existing issue that requests the same feature, to avoid duplicates. + - type: textarea id: feature-description attributes: label: Clear and concise description of the problem - description: As a developer using cherry-markdown I want [goal / wish] so that [benefit]. + description: As a developer using cherry-markdown I want [goal / wish] so that [benefit]. placeholder: Feature description validations: required: true + - type: textarea id: suggested-solution attributes: label: Suggested solution - description: 'I want a xx function that can be used to do xxx things. Its implementation is beneficial for...' + description: "I want a xx function that can be used to do xxx things. Its implementation is beneficial for..." + - type: textarea id: additional-context attributes: label: Further Information description: Provide any other relevant information or screenshots about the feature request here. + - type: dropdown id: help-us attributes: diff --git a/.github/ISSUE_TEMPLATE/documentation_feedback.yml b/.github/ISSUE_TEMPLATE/3.documentation_feedback.yml similarity index 88% rename from .github/ISSUE_TEMPLATE/documentation_feedback.yml rename to .github/ISSUE_TEMPLATE/3.documentation_feedback.yml index ddfa88c54..91d48d6a2 100644 --- a/.github/ISSUE_TEMPLATE/documentation_feedback.yml +++ b/.github/ISSUE_TEMPLATE/3.documentation_feedback.yml @@ -1,12 +1,14 @@ name: 📃 Documentation Feedback description: Ask a question or submit a bug related to our documentation -title: '[Docs]' -labels: [docs] +title: "[Docs]" +labels: [📃documentation, pending-no-confirmed] body: - type: markdown attributes: value: | Thank you for your interest in the project and taking the time to provide your feedback. + [For current usage documentation, please see here.](https://github.com/Tencent/cherry-markdown/wiki) + - type: checkboxes id: prerequisites attributes: @@ -14,6 +16,7 @@ body: description: 'Before submitting the issue, ensure the following:' options: - label: There isn't an existing issue with the same question or request to avoid duplicates. + - type: dropdown id: type attributes: @@ -25,6 +28,7 @@ body: - Update Request validations: required: true + - type: textarea id: issue-description attributes: @@ -32,11 +36,13 @@ body: placeholder: Describe your questions or share your ideas here. validations: required: true + - type: textarea id: additional-context attributes: label: Further Information description: Provide any other relevant information or screenshots about the question here. + - type: dropdown id: help-us attributes: diff --git a/.github/ISSUE_TEMPLATE/client_feedback.yml b/.github/ISSUE_TEMPLATE/5.client_feedback.yml similarity index 64% rename from .github/ISSUE_TEMPLATE/client_feedback.yml rename to .github/ISSUE_TEMPLATE/5.client_feedback.yml index 5a74f8b45..c5b66484f 100644 --- a/.github/ISSUE_TEMPLATE/client_feedback.yml +++ b/.github/ISSUE_TEMPLATE/5.client_feedback.yml @@ -1,29 +1,40 @@ name: 💻 Client Feedback description: Client feedback -title: '[Client]' -labels: [client] +title: "[Client]" +labels: [💻client, pending-no-confirmed] body: - type: markdown attributes: - value: | - Thank you for your interest in the project and for taking the time to provide your feedback. + value: Thank you for your interest in the project and for taking the time to provide your feedback. + - type: checkboxes id: prerequisites attributes: label: Prerequisites - description: 'Before submitting the issue, ensure the following:' + description: "Before submitting the issue, ensure the following:" options: - label: There isn't an existing issue that requests the same feature, to avoid duplicates. + - type: dropdown id: type attributes: label: Issue Type - description: What type of issue is this? + description: What type of issue is this? options: - Bug Report - Feature Request validations: - required: true + required: true + + - type: input + id: version + attributes: + label: Version + description: If it is a bug, please tell us which version the bug occurred in. If it is a Feature, please tell us which version you are currently using. + placeholder: v1.0.0 + validations: + required: true + - type: textarea id: issue-description attributes: @@ -31,11 +42,13 @@ body: placeholder: Describe your questions or share your ideas here. validations: required: true + - type: textarea id: further-info attributes: label: Further Information description: Provide any other relevant information or screenshots about the feature request here. + - type: dropdown id: help-us attributes: diff --git a/.github/ISSUE_TEMPLATE/vscode_plugin_report.yml b/.github/ISSUE_TEMPLATE/6.vscode_plugin_feedback.yml similarity index 59% rename from .github/ISSUE_TEMPLATE/vscode_plugin_report.yml rename to .github/ISSUE_TEMPLATE/6.vscode_plugin_feedback.yml index 72d26bcda..ae85d2b5f 100644 --- a/.github/ISSUE_TEMPLATE/vscode_plugin_report.yml +++ b/.github/ISSUE_TEMPLATE/6.vscode_plugin_feedback.yml @@ -1,22 +1,40 @@ -name: 🔌 VSCode Plugin issue +name: 🔌 VSCode Plugin Feedback description: About VSCode Plugin issue -title: '[VSCode Plugin]' -labels: [VSCode Plugin] +title: "[VSCode Plugin]" +labels: [🔌vscode-plugin, pending-no-confirmed] body: - type: markdown attributes: - value: | - Thanks for your interest in the project and taking the time to fill out this feature report! + value: Thank you for your interest in the project and for taking the time to provide your feedback. + + - type: checkboxes + id: checkboxes + attributes: + label: Validations + description: Before submitting the issue, please make sure you do the following + options: + - label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate. + - type: dropdown id: type attributes: - label: issue type - description: What type of issue is this about VSCode Plugin? + label: Issue Type + description: What type of issue is this? options: - - Bug - - Feature + - Bug Report + - Feature Request + validations: + required: true + + - type: input + id: version + attributes: + label: Version + description: If it is a bug, please tell us which version the bug occurred in. If it is a Feature, please tell us which version you are currently using. + placeholder: v1.0.0 validations: - required: true + required: true + - type: textarea id: issue-description attributes: @@ -24,23 +42,18 @@ body: placeholder: Questions or ideas. validations: required: true + - type: textarea id: additional-context attributes: label: Additional context description: Any other context or screenshots about the feature request here. - - type: checkboxes - id: checkboxes - attributes: - label: Validations - description: Before submitting the issue, please make sure you do the following - options: - - label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate. + - type: dropdown id: help-us attributes: label: Help us - description: Do you plan to submit a PR for this issue? + description: Do you plan to submit a PR for this issue? options: - Yes, I would like to try submitting a PR for this issue. - No, I don't want to do it now. diff --git a/.github/ISSUE_TEMPLATE/other.md b/.github/ISSUE_TEMPLATE/other.md deleted file mode 100644 index 29e6218b1..000000000 --- a/.github/ISSUE_TEMPLATE/other.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -name: Others -about: Suggest an idea for this project -title: '[Others]' -labels: '' -assignees: '' - ---- - diff --git a/.github/ISSUE_TEMPLATE/other_feedback.yml b/.github/ISSUE_TEMPLATE/other_feedback.yml new file mode 100644 index 000000000..dd3e62211 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other_feedback.yml @@ -0,0 +1,16 @@ +name: ✏️ Others +description: If none of them are in other ranges, please use this to illustrate. +title: "[Others]" +labels: [pending-no-confirmed] +body: + - type: markdown + attributes: + value: Thank you for your interest in the project and for taking the time to provide your feedback. + + - type: textarea + id: issue-description + attributes: + label: Clear and concise description of the problem or idea. + placeholder: Questions or ideas. + validations: + required: true