Doc: Add github issue template

This commit is contained in:
LmeSzinc 2023-10-09 12:17:02 +08:00
parent 2278e2b9b5
commit e8cd2ee948
4 changed files with 185 additions and 0 deletions

View File

@ -0,0 +1,67 @@
name: 上报 Bug
description: 使用中文进行 Bug 报告
labels: ['bug / 缺陷']
body:
- type: checkboxes
id: checks
attributes:
label: 在提问之前...
options:
- label: 我已经搜索了现有的 issues
required: true
- label: 我在提问题之前至少花费了 5 分钟来思考和准备
required: true
- label: 我正在使用最新版的 SRC
required: true
- type: textarea
id: describe
attributes:
label: 描述你的问题
description: 简要描述你的问题
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: 如何复现
description: 重现该行为的步骤
value: |
1. 前往 '...'
2. 点击 '....'
3. 滑动到 '....'
4. 出现问题
validations:
required: false
- type: textarea
id: expected
attributes:
label: 预期行为
description: 简要描述你期望发生的事情
validations:
required: false
- type: textarea
id: logs
attributes:
label: 相关 Logs
description: 请复制并粘贴任何相关的日志输出。
render: Text
validations:
required: false
- type: textarea
id: screenshots
attributes:
label: 截图
description: |
如果有,添加屏幕截图以帮助解释你的问题。
提示: 可以通过点击这个区域,然后把文件拖进来添加图片或日志文件。
validations:
required: false
- type: textarea
id: others
attributes:
label: 还有别的吗?
description: |
相关的配置?链接?参考资料?
任何能让我们对你所遇到的问题有更多了解的东西。
validations:
required: false

View File

@ -0,0 +1,67 @@
name: Bug Report
description: Create a report to help us improve
labels: ['bug / 缺陷']
body:
- type: checkboxes
id: checks
attributes:
label: Before you asking
options:
- label: I have searched the existing issues
required: true
- label: I spend at least 5 minutes for thinking and preparing
required: true
- label: I am using the latest version of SRC
required: true
- type: textarea
id: describe
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: To Reproduce
description: Steps to reproduce the behavior
value: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: false
- type: textarea
id: expected
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: false
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: Text
validations:
required: false
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: |
If applicable, add screenshots to help explain your problem.
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
- type: textarea
id: others
attributes:
label: Anything else?
description: |
Related configs? Links? References?
Anything that will give us more context about the issue you are encountering!
validations:
required: false

View File

@ -0,0 +1,25 @@
name: 功能请求
description: 使用中文进行功能请求
labels: ['feature request / 功能请求']
body:
- type: textarea
id: describe
attributes:
label: 你的功能请求是否与问题有关?
description: 简要描述相关的问题
validations:
required: false
- type: textarea
id: solution
attributes:
label: 解决方案
description: 描述你想要的解决方案
validations:
required: false
- type: textarea
id: additional
attributes:
label: 其他内容
description: 关于该功能请求的任何其他背景或屏幕截图。
validations:
required: false

View File

@ -0,0 +1,26 @@
name: Feature request
description: Suggest an idea for this project
labels: ['feature request / 功能请求']
body:
- type: textarea
id: describe
attributes:
label: Is your feature request related to a problem?
description: A clear and concise description of what the problem is
placeholder: Ex. I'm always frustrated when ...
validations:
required: false
- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen
validations:
required: false
- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
validations:
required: false