From 63e3a90346bfdb1de3aa25af21c1612a011cce49 Mon Sep 17 00:00:00 2001 From: Karako <70872201+karakoo@users.noreply.github.com> Date: Fri, 7 Oct 2022 17:53:56 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20=E6=B7=BB=E5=8A=A0issue=E6=A8=A1?= =?UTF-8?q?=E6=9D=BF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: xtaodada --- .github/ISSUE_TEMPLATE/bug-report.yaml | 127 ++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/new-feature.yaml | 43 ++++++++ 3 files changed, 171 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/new-feature.yaml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 0000000..07f8355 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,127 @@ +name: 回报错误 +description: 告诉我们你遇到的问题 +title: '[Bug]: ' +labels: [ "bug 🐛" ] + +body: + # User's README and agreement + - type: markdown + attributes: + value: | + ## 感谢您愿意填写错误回报! + ## 以下是一些注意事项,请务必阅读让我们能够更容易处理 + + ### ❗ | 确定没有相同问题的ISSUE已被提出。 + ### 🌎| 请准确填写环境信息。 + ### ❔ | 打开DEBUG模式复现,并提供出现问题前后至少 10 秒的完整日志内容。请自行删除日志内存在的个人信息及敏感内容。 + + ## 如果您不知道如何有效、精准地表述,我们建议您先阅读《提问的智慧》 + 链接: [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md) + --- + - type: checkboxes + id: terms + attributes: + label: 请确保您已阅读以上注意事项,并勾选下方的确认框。 + options: + - label: "我已经使用一个干净且无其它非必要的插件的环境测试过,问题依旧存在。" + required: true + - label: "我已经在 [Issue Tracker](https://github.com/luoshuijs/TGPaimonBot/issues) 中找过我要提出的问题,没有找到相同问题的ISSUE。" + required: true + - label: 我已知晓并同意,此处仅用于汇报程序中存在的问题。若这个 Issue 是关于其他非程序本身问题,则我的 Issue 可能会被无条件自动关闭或/并锁定。 + required: true + - label: 我已知晓并同意,如果我不按照模板提供的指示进行填写,则我的 Issue 可能会被无条件删除。 + required: true + + # User's data + - type: markdown + attributes: + value: | + ## 环境信息 + 请根据实际使用环境修改以下信息。 + + # Env | Version + - type: input + id: env-pgm-ver + attributes: + label: 程序版本 (Commit Id) + validations: + required: true + + # Env | VM Version + - type: dropdown + id: env-vm-ver + attributes: + label: 运行环境 + description: 选择系统版本 + options: + - Windows (64) + - Windows (32/x84) + - MacOS + - Linux + - Ubuntu + - CentOS + - ArchLinux + - UNIX (Android) + - 其它(请在下方说明) + validations: + required: true + + # Env | VM Arch + - type: dropdown + id: env-vm-arch + attributes: + label: 运行架构 + description: (可选) 选择系统架构 + options: + - AMD64 + - x86 + - ARM [32] (别名:AArch32 / ARMv7) + - ARM [64] (别名:AArch64 / ARMv8) + - 其它 + + # Input | Reproduce + - type: textarea + id: reproduce-steps + attributes: + label: 重现步骤 + description: | + 我们需要执行哪些操作才能让 Bug 出现? + 简洁清晰的重现步骤能够帮助我们更迅速地定位问题所在。 + validations: + required: true + + # Input | Expected result + - type: textarea + id: expected + attributes: + label: 期望的结果是什么? + validations: + required: true + + # Input | Actual result + - type: textarea + id: actual + attributes: + label: 实际的结果是什么? + validations: + required: true + + # Optional | Reproduce code + - type: textarea + id: reproduce-code + attributes: + label: 简单的复现代码/链接(可选) + render: python3 + + # Optional | Logging + - type: textarea + id: logging + attributes: + label: 日志记录(可选) + render: python3 + + # Optional | Extra description + - type: textarea + id: extra-desc + attributes: + label: 补充说明(可选) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/new-feature.yaml b/.github/ISSUE_TEMPLATE/new-feature.yaml new file mode 100644 index 0000000..fdc8f11 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-feature.yaml @@ -0,0 +1,43 @@ +name: 新功能提议 +description: 提出新功能 +title: '[Feat]: ' +labels: [ "enhancement ✨" ] + +body: + # User's README and agreement + - type: markdown + attributes: + value: | + ## 感谢您愿意为本程序提出建议! + ## 以下是一些注意事项,请务必阅读让我们能够更容易处理 + + ### ❗ | 确定没有相同问题的Feature已被提出或实现。 + ### 📝 | 确定现有的PR和代码并没有该功能的实现/相似的功能。 + + ## 如果您不知道如何有效、精准地表述,我们建议您先阅读《提问的智慧》 + 链接: [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md) + --- + - type: checkboxes + id: terms + attributes: + label: 请确保您已阅读以上注意事项,并勾选下方的确认框。 + options: + - label: "我确定这是一个从未被提出和实现过的功能。" + required: true + - label: "我已经在 [Issue Tracker](https://github.com/luoshuijs/TGPaimonBot/issues) 以及 [Pull Request](https://github.com/luoshuijs/TGPaimonBot/pulls) 中找过我要提出的功能,没有找到相同功能的ISSUE和PR。" + required: true + - label: 我已知晓并同意,此处仅用于建议新功能。若这个 Issue 是关于其他非主题的问题,则我的 Issue 可能会被无条件自动关闭或/并锁定。 + required: true + - label: 我已知晓并同意,如果我不按照模板提供的指示进行填写,则我的 Issue 可能会被无条件删除。 + required: true + + # Input | Feature + - type: textarea + id: feature-to-add + attributes: + label: 需要添加的功能内容 + description: | + 请具体提出想添加的功能,包括实现的模拟(如有) + 是否有类似的功能已经实现?如有请肯定地提出与该功能不同的地方/想改进/添加该功能的哪一部分。 + validations: + required: true