贡献

本文是关于向 Coral 项目做出贡献的指南。

若你想以非提交代码方式帮助 Coral 项目，你可以为 Coral 编写插件，或者为 Coral 制作教程、视频、文章等。

Git 分支

1. main 分支：该分支为最新稳定版本，所有提交都应该基于该分支。
2. dev 分支：该分支为开发分支，所有开发都应该基于该分支。

通常请基于 dev 分支进行开发，并在 main 分支上进行合并（除非紧急修复）。

贡献代码

1. Fork 项目到你的 GitHub 账户。
2. 克隆你 fork 的项目到本地。
3. 创建一个新的分支，并在该分支上进行修改。
4. 确保你的修改符合项目的规范。
5. 提交你的修改，并向项目的维护者发起 Pull Request。
6. 等待项目的维护者审核你的 Pull Request，并与你一起改进代码（不要使用force push）。
7. 完成代码审查后，你的修改将被合并到主分支。

寻找待解决的问题

Coral 是一个开源项目，任何人都可以贡献代码。但我们也需要你的帮助来解决问题。如果你发现了一个 bug，或者有任何改进建议，请在项目的 Issue 区进行反馈。

规范

1. 代码规范

   1. 代码应尽量简洁，在每个函数、模块、类中添加必要的注释(请尽量使用简体中文)。

   2. 不要使用 “神奇老头的秘密小数字” 定义变量，变量名应清晰易懂。

   3. 不要使用过多嵌套的 if-else 语句，我们不想吃坨大的。

2. 关于PR

   1. 请确保PR的目标分支为dev分支。

   2. PR 标题应简明扼要，并包含修改的范围和目的。

      示例：fix(xxx): 修复了 xxx 问题

   3. 确保 PR 只解决一类问题

      一个 PR 只能解决一个（类）问题，比如修复一个bug，添加一个新功能，优化一个功能等，避免出现 “一锅烩” 的情况。孩子们我也干了

   4. 确保 commit 的可阅读性

      请确保 commit 的信息清晰易懂，建议遵循 conventional commit 规范。

      commit 必须不带有或指明必要的副作用，如 fix(adapters): 无法发送图片 实际却附带更改了消息长度的限制。

      若要修复某一个 issue，请不要仅提交 fix(xxx): #issue-number 这样的 commit，而应该附带更多信息，如 fix(xxx): #issue-number 修复了 xxx 问题。

   5. PR 在有审核后避免 force push

      PR 在有人审核（review）后，请不要进行 force push(git push -f)，否则将可能会导致审核人需要重新审核你的全部代码。