docs: add how to contribute

This commit is contained in:
KaiyiWing
2023-04-27 18:41:33 +08:00
parent e757586930
commit 1c467d88df
3 changed files with 56 additions and 4 deletions

45
docs/CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,45 @@
# 开源代码贡献准则
## PR 来源
1. 我们会在 GitHub 上将需要完成的 feature 和修复的 bug 标记为 "Help Wanted"
2. 用户在用户社群(在项目官方部署的 footer 中有二维码)提出的需求和 bug
3. 根据大家对项目的理解和兴趣,认为需要做的 feature 和修复的 bug
## 在开始做 PR 之前
1.**开发者社群或 issue 区** 进行讨论,确认这个 PR 符合项目需求,并考虑对现有代码和未来计划的影响
2. 在 GitHub 上创建相关的 issue已有 issue 则无须创建),并进行回复。尽可能在 issue 描述了问题、解决方案、相关细节和贡献者预期的工作,方便大家进行讨论
3. 确认开始 issue 后,尽可能在一周内解决(相对复杂的 issue 除外),以免 PR 长期无法推进,其他开发者也无法参与
## 在 PR 过程中
1. 在开始 coding 后,尽早提出一个 draft PR方便其他开发者参与讨论给出建议和帮助
2. 遇到任何技术问题和实现路线问题,可以在 开发者社群或 issue 区 进行讨论。确保 PR 满足项目的开发规范和质量标准,经过充分测试和文档支持
3. 在 PR 中友好协作,回应 Code Review。接受反馈并进行改进遵守代码风格和注释规范确保代码的可读性和可维护性
4. 其他人也可以对 PR 进行 Review帮助发现代码中的问题提出自己的建议和想法
## 完成 PR 后
1. 标记相关 issue 为完成。确保代码被合并到主分支,并在生产环境中经过充分测试和部署
2. 如果是用户社群的相关需求,可以在社群内对用户进行回复
## 行为准则
1. 尊重所有贡献者,不论其技术水平、经验、性别、性取向、种族、宗教信仰或国籍
2. 保持开放的心态,愿意接受其他人的批评和建议,并根据反馈进行改进
3. 提交有价值的贡献,符合项目需求并遵守项目的开发规范和质量标准
4. 不要在 PR 或讨论中使用不礼貌或侮辱性的语言,不要发布任何垃圾或攻击性的内容
5. 遵守代码行为准则,不要进行不道德或不法的行为,如抄袭、篡改他人代码、恶意破坏等
6. 避免进行灌水式的讨论或评论,尽量保持话题与项目相关,并尊重他人的意见和观点
7. 遵守相关法律法规和 GitHub 平台的规定,不发布含有违法、政治或淫秽内容的 PR 或评论
## 反馈
如有任何问题或建议,请随时在 issue 区或者群内提出,我们将及时解决。同时,欢迎参与项目的讨论和开发,共同打造更加优秀的开源项目!
## 写在最后
不要害怕提出问题,不要害怕提出 PR不要害怕提出建议不要害怕提出想法不要害怕提出质疑不要害怕提出帮助不要害怕提出改进
![kai-fu](./kai-fu.png)

BIN
docs/kai-fu.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 136 KiB