📝 Update issue template

2024-11-21 15:58:19 +00:00 · 2022-07-10 22:44:46 +08:00 · 2022-07-10 22:44:46 +08:00 · 7932a3a6ff
commit 7932a3a6ff
parent 799b901054
8 changed files with 196 additions and 88 deletions
--- a/.github/ISSUE_TEMPLATE/bug-report.yaml
+++ b/.github/ISSUE_TEMPLATE/bug-report.yaml
@ -0,0 +1,137 @@
+name: 回报错误
+description: 在使用 PagerMaid 过程中遇到了错误
+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/TeamPGM/PagerMaid-Pyro/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: PagerMaid 版本 （或 Commit Id）
+    validations:
+      required: true
+
+  # Env | VM Version
+  - type: dropdown
+    id: env-vm-ver
+    attributes:
+      label: 运行环境
+      description: 选择运行 PagerMaid 的系统版本
+      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: (可选) 选择运行 PagerMaid 的系统架构
+      options:
+        - AMD64
+        - x86
+        - ARM [32] (别名：AArch32 / ARMv7）
+        - ARM [64] (别名：AArch64 / ARMv8）
+        - 其它
+
+  # Input | Plugin
+  - type: textarea
+    id: plugin
+    attributes:
+      label: 导致错误的插件是什么？
+      description: |
+        请输入插件名称
+    validations:
+      required: true
+
+  # 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: 补充说明（可选）
--- a/.github/ISSUE_TEMPLATE/bug_report_en.md
+++ b/.github/ISSUE_TEMPLATE/bug_report_en.md
@ -1,23 +0,0 @@
---
-name: 🐛 Bug Report
-about: Submit discovered bugs
---
-
-<!--
-Please ensure you have read [wiki](https://xtaolabs.com) and [issue](https://github.com/Xtao-Labs/PagerMaid-Modify/issues), and provide all the information required by this template.
-Otherwise the issue will be closed immediately.Please do not repeat the issue.
-->
-
-### BUG occurrence address
-
-### What is expected?
-
-### What is actually happening?
-
-### Additional info (logs errors etc)
-
-<!--
-Please ensure you have deployed the [master branch](https://github.com/Xtao-Labs/PagerMaid-Modify/tree/master) 
-
-generated by github-issue-template.This issue is in English.
-->
--- a/.github/ISSUE_TEMPLATE/bug_report_zh.md
+++ b/.github/ISSUE_TEMPLATE/bug_report_zh.md
@ -1,23 +0,0 @@
---
-name: 🐛 Bug 报告
-about: 早起的虫子被你抓
---
-
-<!--
-请确保已阅读 [文档](https://xtaolabs.com) 和 [issue](https://github.com/Xtao-Labs/PagerMaid-Modify/issues) 内相关部分，并按照模版提供信息
-否则 issue 将被立即关闭，请勿重复提issue
-->
-
-### BUG 发生地址
-
-### 预期是什么？
-
-### 实际发生了什么？
-
-### 额外信息（日志、报错等）
-
-<!--
-请确保您部署的是[主线 master 分支](https://github.com/Xtao-Labs/PagerMaid-Modify/tree/master)的最新版
-
-generated by github-issue-template
-->
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 不知道怎么做?
+    url: https://t.me/+pCLtkzj4Yo41ZTM9
+    about: 加入群聊进行询问，请注意您的问题有可能会被忽略（开发者太忙了）
--- a/.github/ISSUE_TEMPLATE/feature_request_en.md
+++ b/.github/ISSUE_TEMPLATE/feature_request_en.md
@ -1,19 +0,0 @@
---
-name: 🍰 Feature Request
-about: Submit a new feature request
---
-
-<!--
-Feature Request(https://xtaolabs.com) and [issue](https://github.com/Xtao-Labs/PagerMaid-Modify/issues) , and provide all the information required by this template.
-Otherwise the issue will be closed immediately.
-->
-
-### What feature is it?
-
-### What can this function do?
-
-### Additional description
-
-<!--
-generated by github-issue-template.This issue is in English.
-->
--- a/.github/ISSUE_TEMPLATE/feature_request_zh.md
+++ b/.github/ISSUE_TEMPLATE/feature_request_zh.md
@ -1,19 +0,0 @@
---
-name: 🍰 功能需求
-about: 提交新的功能需求
---
-
-<!--
-请确保 [文档](https://xtaolabs.com) 和 [issue](https://github.com/Xtao-Labs/PagerMaid-Modify/issues) 中没有相关内容，并按照模版提供信息
-否则 issue 将被立即关闭
-->
-
-### 这是一个什么样的功能？
-
-### 这个 feature 可以干什么？
-
-### 额外描述
-
-<!--
-generated by github-issue-template
-->
--- a/.github/ISSUE_TEMPLATE/new-feature.yaml
+++ b/.github/ISSUE_TEMPLATE/new-feature.yaml
@ -0,0 +1,49 @@
+name: 新功能提议
+description: 提出新功能
+title: '[Feat]: '
+labels: [ "feat?" ]
+
+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/TeamPGM/PagerMaid-Pyro/issues) 以及 [Pull Request](https://github.com/TeamPGM/PagerMaid-Pyro/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
+
+  # Optional | Extra description
+  - type: textarea
+    id: extra-desc
+    attributes:
+      label: 补充说明（可选）
--- a/README.md
+++ b/README.md
@ -1,10 +1,11 @@
 # PagerMaid-Plugins
+
 PagerMaid-Pyro 的插件。

-## 关于分支
-`master` 分支用来存放 PagerMaid-Modify 的插件。  
-`v2` 分支用来存放 PagerMaid-Pyro 的插件。  
+## 关于此仓库
+
+此仓库用来存放 [PagerMaid-Pyro](https://github.com/TeamPGM/PagerMaid-Pyro) 的插件。  

 ⚠ **请注意，不同版本的插件不通用。**  

-⚠ **当前分支为 `v2` ，PagerMaid-Modify 版插件请前往 [master 分支](https://github.com/TeamPGM/PagerMaid_Plugins/tree/master)**。
+⚠ **PagerMaid-Modify 版插件请前往 [PagerMaid_Plugins](https://github.com/TeamPGM/PagerMaid_Plugins/tree/master)**。