From 5e225b2898e5ae50ee0b125a98281b744cd0dce8 Mon Sep 17 00:00:00 2001 From: Akirami <66513481+A-kirami@users.noreply.github.com> Date: Sun, 23 Apr 2023 11:58:25 +0800 Subject: [PATCH] =?UTF-8?q?:memo:=20Docs:=20=E4=BD=BF=E7=94=A8=20issue=20?= =?UTF-8?q?=E8=A1=A8=E5=8D=95=E6=9B=BF=E6=8D=A2=20issue=20=E6=A8=A1?= =?UTF-8?q?=E6=9D=BF=20(#1928)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: StarHeart Co-authored-by: Ju4tCode <42488585+yanyongyu@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug-report.md | 38 ---------- .github/ISSUE_TEMPLATE/bug_report.yml | 85 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/document.md | 17 ----- .github/ISSUE_TEMPLATE/document.yml | 18 +++++ .github/ISSUE_TEMPLATE/feature_request.md | 16 ---- .github/ISSUE_TEMPLATE/feature_request.yml | 20 +++++ 6 files changed, 123 insertions(+), 71 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/document.md create mode 100644 .github/ISSUE_TEMPLATE/document.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 4d4bd585..00000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a bug report to help us improve -title: 'Bug: Something went wrong' -labels: bug -assignees: '' - ---- - -**描述问题：** - -A clear and concise description of what the bug is. - -**如何复现？** - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**期望的结果** - -A clear and concise description of what you expected to happen. - -**环境信息：** - - - OS: [e.g. Linux] - - Python Version: [e.g. 3.8] - - Nonebot Version: [e.g. 2.0.0] - -**协议端信息：** - - - 协议端: [e.g. go-cqhttp] - - 协议端版本: [e.g. 1.0.0] - -**截图或日志** - -If applicable, add screenshots to help explain your problem. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..c91b68b7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,85 @@ +name: Bug 反馈 +title: "Bug: 出现异常" +description: 提交 Bug 反馈以帮助我们改进代码 +labels: ["bug"] +body: + - type: dropdown + id: env-os + attributes: + label: OS + 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. 2.0.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: 填写使用的适配器以及版本 + placeholder: e.g. OneBot v11 2.2.2 + validations: + required: true + + - type: input + id: env-protocol + attributes: + label: 协议端 + description: 填写连接 NoneBot 的协议端及版本 + placeholder: e.g. go-cqhttp 1.0.0 + 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: 提供有助于诊断问题的任何日志和截图 diff --git a/.github/ISSUE_TEMPLATE/document.md b/.github/ISSUE_TEMPLATE/document.md deleted file mode 100644 index aa295ceb..00000000 --- a/.github/ISSUE_TEMPLATE/document.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Document improvement -about: Feedback on documentation, including errors and ideas -title: 'Docs: some description' -labels: documentation -assignees: '' - ---- - -**描述问题或主题：** - - -**需做出的修改：** - -* [ ] 一些修改 -* [ ] 一些修改 -* [ ] 一些修改 diff --git a/.github/ISSUE_TEMPLATE/document.yml b/.github/ISSUE_TEMPLATE/document.yml new file mode 100644 index 00000000..352a13b2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/document.yml @@ -0,0 +1,18 @@ +name: 文档改进 +title: "Docs: 描述" +description: 文档错误及改进意见反馈 +labels: ["documentation"] +body: + - type: textarea + id: problem + attributes: + label: 描述问题或主题 + validations: + required: true + + - type: textarea + id: improve + attributes: + label: 需做出的修改 + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 045a2e25..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: 'Feature: Something you want' -labels: enhancement -assignees: '' - ---- - -**是否在使用中遇到某些问题而需要新的特性？请描述：** - -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**描述你所需要的特性：** - -A clear and concise description of what you want to happen. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..4f2e79f7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,20 @@ +name: 功能建议 +title: "Feature: 功能描述" +description: 提出关于项目新功能的想法 +labels: ["enhancement"] +body: + - type: textarea + id: problem + attributes: + label: 希望能解决的问题 + description: 在使用中遇到什么问题而需要新的功能？ + validations: + required: true + + - type: textarea + id: feature + attributes: + label: 描述所需要的功能 + description: 请说明需要的功能或解决方法 + validations: + required: true