Skip to content

Commit

Permalink
🔧 add issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
RF-Tar-Railt committed Mar 12, 2024
1 parent 5412714 commit e0ec78b
Show file tree
Hide file tree
Showing 5 changed files with 151 additions and 3 deletions.
9 changes: 7 additions & 2 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Bug 报告
about: 有关 bug 的报告
name: Bug 反馈 (Classic)
about: 有关 bug 的反馈
title: "[Bug]"
labels: bug, triage
assignees: ""
Expand Down Expand Up @@ -30,5 +30,10 @@ assignees: ""
- 适配器版本:
- 使用的 Satori 服务端 (例如 Chronocat):

## 配置文件
<!-- 请将你的 .env 配置文件放到这里,如果你的配置文件中包含敏感信息,请自行删除 -->
```dotenv
```

## 日志/截图
<!-- 将任何有关的日志/截图放到这里(如:控制台输出) -->
110 changes: 110 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
name: Bug 反馈
title: "[Bug]: "
description: 提交 Bug 反馈以帮助我们改进代码
labels: ["bug"]
body:
- type: checkboxes
id: ensure
attributes:
label: 确认项
description: 请确认以下选项
options:
- label: 问题的标题明确
required: true
- label: 我翻阅过其他的 issue 并且找不到类似的问题
required: true
- label: 我已经阅读了[相关文档](https://satori.js.org/zh-CN/) 并仍然认为这是一个 Bug
required: true
- label: 我已经尝试过在最新的代码中修复这个问题
required: false
- type: dropdown
id: env-os
attributes:
label: 操作系统
description: 选择运行 NoneBot 的系统
options:
- Windows
- MacOS
- Linux
- Other
validations:
required: true

- type: input
id: env-python-ver
attributes:
label: Python 版本
description: 填写运行 NoneBot 的 Python 版本
placeholder: e.g. 3.11.0
validations:
required: true

- type: input
id: env-nb-ver
attributes:
label: NoneBot 版本
description: 填写 NoneBot 版本
placeholder: e.g. 2.0.0
validations:
required: true

- type: input
id: env-adapter
attributes:
label: 适配器
description: 填写使用的 Satori 适配器版本
placeholder: e.g. 0.10.0
validations:
required: true

- type: input
id: env-server
attributes:
label: 协议端
description: 填写对接的 Satori 服务端
placeholder: e.g. Chronocat
validations:
required: true

- type: textarea
id: describe
attributes:
label: 描述问题
description: 清晰简洁地说明问题是什么
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: 复现步骤
description: 提供能复现此问题的详细操作步骤
placeholder: |
1. 首先……
2. 然后……
3. 发生……
validations:
required: true

- type: textarea
id: expected
attributes:
label: 期望的结果
description: 清晰简洁地描述你期望发生的事情

- type: textarea
id: logs
attributes:
label: 截图或日志
description: 提供有助于诊断问题的任何日志和截图

- type: textarea
id: config
attributes:
label: Nonebot 配置项
description: Nonebot 配置项 (如果你的配置文件中包含敏感信息,请自行删除)
render: dotenv
placeholder: |
# e.g.
# KEY=VALUE
# KEY2=VALUE2
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: Feature 特性请求
name: 功能建议 (Classic)
about: 为适配器加份菜
title: "[Feature] "
labels: enhancement, triage
Expand Down
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: 功能建议
title: "[Feature]: "
description: 提出关于项目新功能的想法
labels: ["enhancement"]
body:
- type: checkboxes
id: ensure
attributes:
label: 确认项
description: 请确认以下选项
options:
- label: 新特性的目的明确
required: true
- label: 我已经使用过该项目并且了解其功能
required: true
- type: textarea
id: problem
attributes:
label: 希望能解决的问题
description: 在使用中遇到什么问题而需要新的功能?
validations:
required: true

- type: textarea
id: feature
attributes:
label: 描述所需要的功能
description: 请说明需要的功能或解决方法
validations:
required: true
3 changes: 3 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,6 @@ ignore = ["E402", "F403", "F405", "C901", "UP037"]
[tool.pyright]
pythonPlatform = "All"
pythonVersion = "3.8"
typeCheckingMode = "basic"
reportShadowedImports = false
disableBytesTypePromotions = true

0 comments on commit e0ec78b

Please sign in to comment.