chore: 添加 issue 和 PR 模板

.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE_BUG.yml

@@ -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.
+ 

.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE_FEATURE.yml

@@ -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.
+ 

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,24 @@
+<!-- 📢 注意：
+
+在提交的 PR 的时候请确保每个 PR 只包含一个功能修改或者优化，请不要把多个更改组合到一个 PR 提交。保持干净可管理的 git 历史记录至关重要。 为确保我们存储库的质量，我们恳请您在提交 PR 时遵守以下准则：
+
+1. 每个 PR 专注于一个单一的、具体的改进。
+2. 不要包括任何不相关或[额外]的修改。
+3. 为所做的更改提供清晰的文档和解释。
+-->
+
+### Background
+<!-- 简要概述此更改背后的基本原理。 包括相关背景、先前的讨论或相关 issue 的链接。 确保变更与项目的总体方向一致。-->
+
+### Changes
+<!-- 简要说明你改动的内容  -->
+
+### Test Plan
+<!-- 描述您如何测试此功能。 包括重现步骤、相关测试用例和任何其他相关信息-->
+
+### PR 规则验证列表
+- [ ] 确保本次 PR 只包含单一的功能修改。
+- [ ] 我已经对我的代码更改进行了充分的测试。
+- [ ] 我已经考虑了我的更改的潜在风险和缓解措施。
+- [ ] 我已经修正了相关文档 
+

README.md

@@ -50,14 +50,14 @@
 5. OpenAI API 负载均衡，限制每个 API Key 每分钟之内调用次数不超过 15次，防止被封。 
 6. 支持配置多个代理，保证高可用。 
 7. 实现 markdown 语法解析和代码高亮，支持复制回复内容功能。 
-8. 后台管理功能，实现系统的动态配置，用户和角色的动态管理。
+8. 后台管理功能，实现系统的动态配置，口令和角色的动态管理。
 
 ## 项目地址
 * Github 地址：https://github.com/yangjian102621/chatgpt-plus
 * 码云地址：https://gitee.com/blackfox/chatgpt-plus
 
 ## TODOLIST
-* [ ] 让用户配置自己的 API KEY，调用自己的 API Key，将不记 Token 的使用次数
+* [ ] 让用户配置自己的 API KEY，调用自己的 API Key，将不消耗口令的对话次数
 * [ ] 嵌入 AI 绘画功能，支持根据描述词生成图片
 * [ ] 接入自己训练的开源大语言模型
 * [ ] 接入 Google 语音 API，支持语音聊天
@@ -82,13 +82,13 @@ chmod +x wechatGPT-amd64-linux
 
 ![系统配置](docs/imgs/config.png)
 
-最后，你还需要一个口令来访问 ChatGPT 前端应用。直接在【后台管理系统->用户管理】新增一个用户就好了。
+最后，你还需要一个口令来访问 ChatGPT 前端应用。直接在【后台管理系统->口令管理】新增一个口令就好了。
 
-![新增用户](docs/imgs/new-user.png)
+![新增口令](docs/imgs/new-user.png)
 
 **切记要先退出后台登录，再登录前端应用！！！前后端账号权限不一致。**
 
-然后直接使用用户名登录前端应用：
+然后直接使用口令名称登录前端应用：
 
 * 角色版：http://localhost:5678/chat/#/plus 
 * 普通版：http://localhost:5678/chat/#/free
@@ -159,7 +159,7 @@ npm install
 npm run dev
 ```
 
-启动之后通过**内网地址**访问后台管理页面：http://172.22.11.200:8888/chat/#/admin ，添加一个用户就可以开始测试了。
+启动之后通过**内网地址**访问后台管理页面：http://172.22.11.200:8888/chat/#/admin ，添加一个口令就可以开始测试了。
 
 ## 项目打包
 由于本项目是采用异构开发的方式，所项目打包分成两步：首先打包前端应用，然后再将打包后前端文件打包进后端应用，最后打成一个包。
@@ -252,6 +252,18 @@ server {
 
 ![微信名片](docs/imgs/wx.png)
 
+#### 特此声明：不接受在微信或者微信群给开发者提 Bug，有问题或者优化建议请提交 Issue 和 PR。非常感谢您的配合！
+
+### Commit 类型
+* feat: 新特性或功能
+* fix: 缺陷修复
+* docs: 文档更新
+* style: 代码风格或者组件样式更新
+* refactor: 代码重构，不引入新功能和缺陷修复
+* opt: 性能优化
+* chore: 一些不涉及到功能变动的小提交，比如修改文字表述，修改注释等
+
+
 ## 打赏
 如果你觉得这个项目对你有帮助，并且情况允许的话，可以请作者喝杯咖啡，非常感谢你的支持～