chore: 添加 issue 和 PR 模板

2026-07-03 02:44:20 +00:00 · 2023-05-09 15:26:38 +08:00
parent 6096b65374
commit 735f9bd053
5 changed files with 124 additions and 6 deletions
@@ -0,0 +1,52 @@
+name: Bug 报告 🐛
+description: 为 chatgpt-plus 提交错误报告
+labels: ['Bug']
+body:
+  - type: checkboxes
+    attributes:
+      label: ⚠️  确认 issue 是否已存在 ⚠️
+      description: 在提交 Issue 之前，请在 issue 列表搜索一下，确保你不是在提交一个重复的 issue。
+      options:
+        - label: 我已经搜索了现有的问题，没有找到跟我问题相关的问题。
+          required: true
+  - type: dropdown
+    attributes:
+      label: GPT-3 or GPT-4
+      description: 请选择你使用的 GPT 模型
+      options:
+        - GPT-3.5
+		- GPT-4
+	validations:
+	  required: true
+  - type: dropdown
+    attributes:
+      label: 操作系统
+      description: 请选择你使用的操作系统
+      options:
+        - Windows
+		- Linux
+		- MacOS
+	validations:
+	  required: true
+  - type: textarea
+    attributes:
+      label: Bug 描述 📝
+      description: 请简单描述你发现的问题。
+  - type: textarea
+    attributes:
+      label: 重现步骤 🕹
+      description: |
+        **⚠️  无法重现的 issue 将会被关闭**
+  - type: textarea
+    attributes:
+      label: 你的应用配置信息
+      description: 请提供你的配置文档，**请注意数据脱敏**。
+	  value: |
+      ```toml
+      把你的配置信息粘贴到这里
+      ```
+  - type: textarea
+    attributes:
+      label: Expected behavior 🤔
+      description: Describe what should happen.
+ 
@@ -0,0 +1,30 @@
+name: 功能优化 🚀
+description: 为 chatgpt-plus 提交优化建议
+labels: ['feature']
+body:
+  - type: checkboxes
+    attributes:
+      label: ⚠️  确认 issue 是否已存在 ⚠️
+      description: >
+        在提交 Issue 之前，请在 issue 列表搜索一下，确保你不是在提交一个重复的 issue。
+      options:
+        - label: 我已经搜索了现有的问题，没有找到相关 issue。
+          required: true
+  - type: textarea
+    attributes:
+      label: 功能描述 📝
+      description: |
+        描述此功能该如何工作。
+  - type: textarea
+    attributes:
+      label: 示例 🌈
+      description: 是否可以提供类似的样例，比如提供参考项目的链接或者截图。
+  - type: textarea
+    attributes:
+      label: 动机 🔦
+      description: 为什么要新增或者优化这个功能，缺少这个功能会给你或者其他用户带来什么不便？
+  - type: textarea
+    attributes:
+      label: Expected behavior 🤔
+      description: Describe what should happen.
+ 
@@ -0,0 +1,24 @@
+<!-- 📢 注意：
+
+在提交的 PR 的时候请确保每个 PR 只包含一个功能修改或者优化，请不要把多个更改组合到一个 PR 提交。保持干净可管理的 git 历史记录至关重要。 为确保我们存储库的质量，我们恳请您在提交 PR 时遵守以下准则：
+
+1. 每个 PR 专注于一个单一的、具体的改进。
+2. 不要包括任何不相关或[额外]的修改。
+3. 为所做的更改提供清晰的文档和解释。
+-->
+
+### Background
+<!-- 简要概述此更改背后的基本原理。 包括相关背景、先前的讨论或相关 issue 的链接。 确保变更与项目的总体方向一致。-->
+
+### Changes
+<!-- 简要说明你改动的内容  -->
+
+### Test Plan
+<!-- 描述您如何测试此功能。 包括重现步骤、相关测试用例和任何其他相关信息-->
+
+### PR 规则验证列表
+- [ ] 确保本次 PR 只包含单一的功能修改。
+- [ ] 我已经对我的代码更改进行了充分的测试。
+- [ ] 我已经考虑了我的更改的潜在风险和缓解措施。
+- [ ] 我已经修正了相关文档 
+