From 1f28740a314d038d8a9b8e693e6a17cd5b5b83dc Mon Sep 17 00:00:00 2001 From: RF-Tar-Railt <3165388245@qq.com> Date: Wed, 11 Oct 2023 18:50:10 +0800 Subject: [PATCH] :wrench: update issue template --- .github/ISSUE_TEMPLATE/bug.md | 9 +- .github/ISSUE_TEMPLATE/bug_report.yml | 110 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature.md | 4 +- .github/ISSUE_TEMPLATE/feature_request.yml | 30 ++++++ 4 files changed, 149 insertions(+), 4 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index 5240483..fe0a90b 100644 --- a/.github/ISSUE_TEMPLATE/bug.md +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -1,5 +1,5 @@ --- -name: Bug 报告 +name: Bug 反馈 (Classic) about: 有关 bug 的报告 title: "[Bug]" labels: bug, triage @@ -28,7 +28,12 @@ assignees: "" - Python 版本: - Nonebot2 版本: - Chronocat 版本: -- 是否使用 `BetterQQNT`: +- Red 适配器版本: + +## 配置文件 + +```dotenv +``` ## 日志/截图 diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..47faad9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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://chronocat.vercel.app) 并仍然认为这是一个 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: 填写使用的Red适配器版本 + placeholder: e.g. 0.5.1 + validations: + required: true + + - type: input + id: env-protocol + attributes: + label: 协议端 + description: 填写 Chronocat 版本 + placeholder: e.g. 0.0.52 + 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 diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md index ee278e5..9cf0686 100644 --- a/.github/ISSUE_TEMPLATE/feature.md +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -1,5 +1,5 @@ --- -name: Feature 特性请求 +name: 功能建议 (Classic) about: 为适配器加份菜 title: "[Feature] " labels: enhancement, triage @@ -9,7 +9,7 @@ assignees: "" ## 请确认: * [ ] 新特性的目的明确 -* [ ] 我已经阅读了[相关文档](https://chronocat.vercel.app) 并且找不到类似特性 +* [ ] 我已经使用过该项目并且了解其功能 ## Feature diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..92cdaeb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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