浏览代码

docs: 增加贡献者指南文档 (#181)

二丫讲梵 2 年之前
父节点
当前提交
5a74cac680
共有 2 个文件被更改,包括 29 次插入0 次删除
  1. 7 0
      .github/pull-request-template.md
  2. 22 0
      CONTRIBUTING.md

+ 7 - 0
.github/pull-request-template.md

@@ -0,0 +1,7 @@
+
+**在提出此拉取请求时,我确认了以下几点(请复选框):**
+
+- [ ] 我已阅读并理解[贡献者指南](https://github.com/eryajf/chatgpt-dingtalk/blob/main/CONTRIBUTING.md)。
+- [ ] 我已检查没有与此请求重复的拉取请求。
+- [ ] 我已经考虑过,并确认这份呈件对其他人很有价值。
+- [ ] 我接受此提交可能不会被使用,并根据维护人员的意愿关闭拉取请求。

+ 22 - 0
CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# 贡献者指南
+
+欢迎反馈、bug报告和拉取请求,可点击[issue](https://github.com/eryajf/chatgpt-dingtalk/issues) 提交.
+
+如果你是第一次进行GitHub的协作,可参阅: [协同开发流程](https://eryajf.github.io/HowToStartOpenSource/views/01-basic-content/03-collaborative-development-process.html)
+
+## 注意事项
+
+- 如果你的变更中新增或者减少了配置,那么需要注意有这么几个地方需要同步调整:
+
+  - [config.go](https://github.com/eryajf/chatgpt-dingtalk/blob/main/config/config.go)
+  - [config.example.yml](https://github.com/eryajf/chatgpt-dingtalk/blob/main/config.example.yml)
+  - [docker-compose.yml](https://github.com/eryajf/chatgpt-dingtalk/blob/main/docker-compose.yml)
+  - [README.md](https://github.com/eryajf/chatgpt-dingtalk/blob/main/README.md)
+    - docker [启动命令](https://github.com/eryajf/chatgpt-dingtalk/blob/main/README.md#docker%E9%83%A8%E7%BD%B2)中要添加。
+    - [配置文件说明](https://github.com/eryajf/chatgpt-dingtalk/blob/main/README.md#%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6%E8%AF%B4%E6%98%8E)要添加。
+
+  一定要检查这几个地方,而且注意务必加好注释,否则将会影响用户升级体验新功能。
+
+- 请务必检查你的提交,是否包含secret,api_key之类的信息,如果要贴示例,注意数据脱敏。
+
+- 如果新增了功能性的模板,则务必在[使用指南](./docs/userGuide.md)中添加对应说明文档。