From 17adbcae529b677fec46868a6b00c922c7f29b46 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Android=20=E8=BD=AE=E5=AD=90=E5=93=A5?= Date: Sat, 8 Jul 2023 17:16:36 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=20issue=20=E6=A8=A1=E6=9D=BF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../ISSUE_TEMPLATE/issue_en_template_bug.yml | 173 ++++++++++++++++++ .../issue_en_template_question.yml | 65 +++++++ .../issue_en_template_suggest.yml | 60 ++++++ .../ISSUE_TEMPLATE/issue_zh_template_bug.yml | 42 ++--- .../issue_zh_template_question.yml | 24 +-- .../issue_zh_template_suggest.yml | 18 +- 6 files changed, 340 insertions(+), 42 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/issue_en_template_bug.yml create mode 100644 .github/ISSUE_TEMPLATE/issue_en_template_question.yml create mode 100644 .github/ISSUE_TEMPLATE/issue_en_template_suggest.yml diff --git a/.github/ISSUE_TEMPLATE/issue_en_template_bug.yml b/.github/ISSUE_TEMPLATE/issue_en_template_bug.yml new file mode 100644 index 0000000..f1ecd2c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_en_template_bug.yml @@ -0,0 +1,173 @@ +name: Submit Bug +description: Please let me know the issues with the framework, and I will assist you in resolving them! +title: "[Bug]:" +labels: ["bug"] + +body: + - type: markdown + attributes: + value: | + ## [Warning: Please make sure to fill in the issue template accurately. If an issue is found to be filled incorrectly, it will be closed without further notice.](https://github.com/getActivity/IssueTemplateGuide) + - type: input + id: input_id_1 + attributes: + label: Framework Version [Required] + description: Please enter the version of the framework you are using. + validations: + required: true + - type: textarea + id: input_id_2 + attributes: + label: Issue Description [Required] + description: Please describe the issue you are facing. + validations: + required: true + - type: textarea + id: input_id_3 + attributes: + label: Steps to Reproduce [Required] + description: Please provide steps to reproduce the issue. + validations: + required: true + - type: dropdown + id: input_id_4 + attributes: + label: Is the Issue Reproducible? [Required] + multiple: false + options: + - "Not Selected" + - "Yes" + - "No" + validations: + required: true + - type: input + id: input_id_5 + attributes: + label: Project targetSdkVersion [Required] + validations: + required: true + - type: input + id: input_id_6 + attributes: + label: Device Information [Required] + description: Please provide the brand and model of the device where the issue occurred. + validations: + required: true + - type: input + id: input_id_7 + attributes: + label: Android Version [Required] + description: Please provide the Android version where the issue occurred. + validations: + required: true + - type: dropdown + id: input_id_8 + attributes: + label: Issue Source Channel [Required] + multiple: true + options: + - Encountered by myself + - Identified in Bugly + - User feedback + - Other channels + - type: input + id: input_id_9 + attributes: + label: Is it specific to certain device models? [Required] + description: Specify whether the issue is specific to certain devices (e.g., specific brand or Android version). + validations: + required: true + - type: dropdown + id: input_id_10 + attributes: + label: Does the latest version of the framework have this issue? [Required] + description: If you are using an older version, it is recommended to upgrade and check if the issue still persists. + multiple: false + options: + - "Not Selected" + - "Yes" + - "No" + validations: + required: true + - type: dropdown + id: input_id_11 + attributes: + label: Is the issue mentioned in the framework documentation? [Required] + description: The documentation provides answers to frequently asked questions. Please check if the information you are looking for is already provided. + multiple: false + options: + - "Not Selected" + - "Yes" + - "No" + validations: + required: true + - type: dropdown + id: input_id_12 + attributes: + label: Did you consult the framework documentation but couldn't find a solution? [Required] + description: If you have consulted the documentation but still couldn't find a solution, you can select "Yes." + multiple: false + options: + - "Not Selected" + - "Yes" + - "No" + validations: + required: true + - type: dropdown + id: input_id_13 + attributes: + label: Has a similar issue been reported in the issue list? [Required] + description: You can search the issue list for keywords related to your problem and refer to the solutions provided by others. + multiple: false + options: + - "Not Selected" + - "Yes" + - "No" + validations: + required: true + - type: dropdown + id: input_id_14 + attributes: + label: Have you searched the issue list but couldn't find a solution? [Required] + description: If you have searched the issue list and couldn't find a solution, you can select "Yes." + multiple: false + options: + - "Not Selected" + - "Yes" + - "No" + validations: + required: true + - type: dropdown + id: input_id_15 + attributes: + label: Can the issue be reproduced with a demo project? [Required] + description: Check if the issue can be reproduced in a minimal demo project to isolate potential issues in your own code. + multiple: false + options: + - "Not Selected" + - "Yes" + - "No" + validations: + required: true + - type: textarea + id: input_id_16 + attributes: + label: Provide Error Stack Trace + description: If there is an error, please provide the stack trace. Note, Do not include obfuscated code in the stack trace. + render: text + validations: + required: false + - type: textarea + id: input_id_17 + attributes: + label: Provide Screenshots or Videos + description: Provide screenshots or videos if necessary. This field is optional. + validations: + required: false + - type: textarea + id: input_id_18 + attributes: + label: Provide a Solution + description: If you have already found a solution, this field is optional. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/issue_en_template_question.yml b/.github/ISSUE_TEMPLATE/issue_en_template_question.yml new file mode 100644 index 0000000..663218e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_en_template_question.yml @@ -0,0 +1,65 @@ +name: Ask a Question +description: Ask your questions, and I will provide you with answers. +title: "[Question]:" +labels: ["question"] + +body: + - type: markdown + attributes: + value: | + ## [Warning: Please make sure to fill in the issue template accurately. If an issue is found to be filled incorrectly, it will be closed without further notice.](https://github.com/getActivity/IssueTemplateGuide) + - type: textarea + id: input_id_1 + attributes: + label: Question Description [Required] + description: Please describe your question (Note, If it is a framework bug, please do not raise it here, as it will not be accepted). + validations: + required: true + - type: dropdown + id: input_id_2 + attributes: + label: Is the issue mentioned in the framework documentation? [Required] + description: The documentation provides answers to frequently asked questions. Please check if the information you are looking for is already provided. + multiple: false + options: + - "Not Selected" + - "Yes" + - "No" + validations: + required: true + - type: dropdown + id: input_id_3 + attributes: + label: Did you consult the framework documentation but couldn't find a solution? [Required] + description: If you have consulted the documentation but still couldn't find a solution, you can select "Yes." + multiple: false + options: + - "Not Selected" + - "Yes" + - "No" + validations: + required: true + - type: dropdown + id: input_id_4 + attributes: + label: Has a similar issue been reported in the issue list? [Required] + description: You can search the issue list for keywords related to your problem and refer to the solutions provided by others. + multiple: false + options: + - "Not Selected" + - "Yes" + - "No" + validations: + required: true + - type: dropdown + id: input_id_5 + attributes: + label: Have you searched the issue list but couldn't find a solution? [Required] + description: If you have searched the issue list and couldn't find a solution, you can select "Yes." + multiple: false + options: + - "Not Selected" + - "Yes" + - "No" + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/issue_en_template_suggest.yml b/.github/ISSUE_TEMPLATE/issue_en_template_suggest.yml new file mode 100644 index 0000000..742e2b9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_en_template_suggest.yml @@ -0,0 +1,60 @@ +name: Submit Suggestion +description: Please let me know the shortcomings of the framework, so that I can improve it! +title: "[Suggestion]:" +labels: ["help wanted"] + +body: + - type: markdown + attributes: + value: | + ## [Warning: Please make sure to fill in the issue template accurately. If an issue is found to be filled incorrectly, it will be closed without further notice.](https://github.com/getActivity/IssueTemplateGuide) + - type: textarea + id: input_id_1 + attributes: + label: What are the shortcomings you have noticed in the framework? [Required] + description: You can describe any aspects of the framework that you are not satisfied with. + validations: + required: true + - type: dropdown + id: input_id_2 + attributes: + label: Has a similar suggestion been made in the issue list? [Required] + description: If a similar suggestion has already been made, I will not address it again. + multiple: false + options: + - "Not Selected" + - "Yes" + - "No" + validations: + required: true + - type: dropdown + id: input_id_3 + attributes: + label: Is the suggestion mentioned in the framework documentation? [Required] + description: The documentation provides answers to frequently asked questions. Please check if the information you are looking for is already provided. + multiple: false + options: + - "Not Selected" + - "Yes" + - "No" + validations: + required: true + - type: dropdown + id: input_id_4 + attributes: + label: Did you consult the framework documentation but couldn't find a solution? [Required] + description: If you have consulted the documentation but still couldn't find a solution, you can select "Yes." + multiple: false + options: + - "Not Selected" + - "Yes" + - "No" + validations: + required: true + - type: textarea + id: input_id_5 + attributes: + label: How do you suggest improving it? [Optional] + description: You can provide your ideas or approaches for the author's reference. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/issue_zh_template_bug.yml b/.github/ISSUE_TEMPLATE/issue_zh_template_bug.yml index 907aab2..af107d8 100644 --- a/.github/ISSUE_TEMPLATE/issue_zh_template_bug.yml +++ b/.github/ISSUE_TEMPLATE/issue_zh_template_bug.yml @@ -35,9 +35,9 @@ body: label: 是否必现【必填】 multiple: false options: - - 未选择 - - 是 - - 否 + - "未选择" + - "是" + - "否" validations: required: true - type: input @@ -84,9 +84,9 @@ body: description: 如果用的是旧版本的话，建议升级看问题是否还存在 multiple: false options: - - 未选择 - - 是 - - 否 + - "未选择" + - "是" + - "否" validations: required: true - type: dropdown @@ -96,9 +96,9 @@ body: description: 文档会提供最常见的问题解答，可以先看看是否有自己想要的 multiple: false options: - - 未选择 - - 是 - - 否 + - "未选择" + - "是" + - "否" validations: required: true - type: dropdown @@ -108,9 +108,9 @@ body: description: 如果查阅了文档但还是没有解决的话，可以选择是 multiple: false options: - - 未选择 - - 是 - - 否 + - "未选择" + - "是" + - "否" validations: required: true - type: dropdown @@ -120,9 +120,9 @@ body: description: 可以在 issue 列表在搜索问题关键字，参考一下别人的解决方案 multiple: false options: - - 未选择 - - 是 - - 否 + - "未选择" + - "是" + - "否" validations: required: true - type: dropdown @@ -132,9 +132,9 @@ body: description: 如果搜索过了 issue 列表但是问题没有解决的话，可以选择是 multiple: false options: - - 未选择 - - 是 - - 否 + - "未选择" + - "是" + - "否" validations: required: true - type: dropdown @@ -144,9 +144,9 @@ body: description: 排查一下是不是自己的项目代码写得有问题导致的 multiple: false options: - - 未选择 - - 是 - - 否 + - "未选择" + - "是" + - "否" validations: required: true - type: textarea diff --git a/.github/ISSUE_TEMPLATE/issue_zh_template_question.yml b/.github/ISSUE_TEMPLATE/issue_zh_template_question.yml index b4159ba..ba56beb 100644 --- a/.github/ISSUE_TEMPLATE/issue_zh_template_question.yml +++ b/.github/ISSUE_TEMPLATE/issue_zh_template_question.yml @@ -22,9 +22,9 @@ body: description: 文档会提供最常见的问题解答，可以先看看是否有自己想要的 multiple: false options: - - 未选择 - - 是 - - 否 + - "未选择" + - "是" + - "否" validations: required: true - type: dropdown @@ -34,9 +34,9 @@ body: description: 如果查阅了文档但还是没有解决的话，可以选择是 multiple: false options: - - 未选择 - - 是 - - 否 + - "未选择" + - "是" + - "否" validations: required: true - type: dropdown @@ -46,9 +46,9 @@ body: description: 可以在 issue 列表在搜索问题关键字，参考一下别人的解决方案 multiple: false options: - - 未选择 - - 是 - - 否 + - "未选择" + - "是" + - "否" validations: required: true - type: dropdown @@ -58,8 +58,8 @@ body: description: 如果搜索过了 issue 列表但是问题没有解决的话，可以选择是 multiple: false options: - - 未选择 - - 是 - - 否 + - "未选择" + - "是" + - "否" validations: required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/issue_zh_template_suggest.yml b/.github/ISSUE_TEMPLATE/issue_zh_template_suggest.yml index f5fea21..e7ef519 100644 --- a/.github/ISSUE_TEMPLATE/issue_zh_template_suggest.yml +++ b/.github/ISSUE_TEMPLATE/issue_zh_template_suggest.yml @@ -22,9 +22,9 @@ body: description: 一旦出现重复提问我将不会再次解答 multiple: false options: - - 未选择 - - 是 - - 否 + - "未选择" + - "是" + - "否" validations: required: true - type: dropdown @@ -34,9 +34,9 @@ body: description: 文档会提供最常见的问题解答，可以先看看是否有自己想要的 multiple: false options: - - 未选择 - - 是 - - 否 + - "未选择" + - "是" + - "否" validations: required: true - type: dropdown @@ -46,9 +46,9 @@ body: description: 如果查阅了文档但还是没有解决的话，可以选择是 multiple: false options: - - 未选择 - - 是 - - 否 + - "未选择" + - "是" + - "否" validations: required: true - type: textarea