Skip to content

Commit

Permalink
更新 issue 模板
Browse files Browse the repository at this point in the history
  • Loading branch information
getActivity committed Jul 8, 2023
1 parent e6dee89 commit 17adbca
Show file tree
Hide file tree
Showing 6 changed files with 340 additions and 42 deletions.
173 changes: 173 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_en_template_bug.yml
Original file line number Diff line number Diff line change
@@ -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
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_en_template_question.yml
Original file line number Diff line number Diff line change
@@ -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
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_en_template_suggest.yml
Original file line number Diff line number Diff line change
@@ -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
42 changes: 21 additions & 21 deletions .github/ISSUE_TEMPLATE/issue_zh_template_bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ body:
label: 是否必现【必填】
multiple: false
options:
- 未选择
-
-
- "未选择"
- ""
- ""
validations:
required: true
- type: input
Expand Down Expand Up @@ -84,9 +84,9 @@ body:
description: 如果用的是旧版本的话,建议升级看问题是否还存在
multiple: false
options:
- 未选择
-
-
- "未选择"
- ""
- ""
validations:
required: true
- type: dropdown
Expand All @@ -96,9 +96,9 @@ body:
description: 文档会提供最常见的问题解答,可以先看看是否有自己想要的
multiple: false
options:
- 未选择
-
-
- "未选择"
- ""
- ""
validations:
required: true
- type: dropdown
Expand All @@ -108,9 +108,9 @@ body:
description: 如果查阅了文档但还是没有解决的话,可以选择是
multiple: false
options:
- 未选择
-
-
- "未选择"
- ""
- ""
validations:
required: true
- type: dropdown
Expand All @@ -120,9 +120,9 @@ body:
description: 可以在 issue 列表在搜索问题关键字,参考一下别人的解决方案
multiple: false
options:
- 未选择
-
-
- "未选择"
- ""
- ""
validations:
required: true
- type: dropdown
Expand All @@ -132,9 +132,9 @@ body:
description: 如果搜索过了 issue 列表但是问题没有解决的话,可以选择是
multiple: false
options:
- 未选择
-
-
- "未选择"
- ""
- ""
validations:
required: true
- type: dropdown
Expand All @@ -144,9 +144,9 @@ body:
description: 排查一下是不是自己的项目代码写得有问题导致的
multiple: false
options:
- 未选择
-
-
- "未选择"
- ""
- ""
validations:
required: true
- type: textarea
Expand Down
Loading

0 comments on commit 17adbca

Please sign in to comment.