GitHub 贡献代码流程

不论您是修复 SOFAJRaft 的 bug 还是新增 SOFAJRaft 的功能，在您提交代码之前，在 SOFAJRaft 的 GitHub 上提交一个 issue，描述您要修复的问题或者要增加的功能。这么做有几个好处:

  • 不会与其它开发者或是他们对这个项目的计划发生冲突，产生重复工作。
  • SOFAJRaft 的维护人员会对您提的 bug 或者新增功能进行相关讨论，确定该修改是不是必要，有没有提升的空间或更好的办法。
  • 在达成一致后再开发，并提交代码，减少双方沟通成本，也减少 pull request 被拒绝的情况。

要修改或新增功能，在提 issue 后，点击左上角的 按钮，复制一份 SOFAJRaft 主干代码到您的代码仓库。

在这之前，可以先看看 SOFAJRaft 的 分支管理策略

  • 下载代码到本地，这一步您可以选择git/https方式。
  • 拉分支准备修改代码
  1. git branch add_xxx_feature
  • 执行完上述命令后，您的代码仓库就切换到相应分支了。执行如下命令可以看到您当前分支：
  1. git branch -a
  • 如果您想切换回主干，执行下面命令：
  • 如果您想切换回分支，执行下面命令：

    拉完分支后，就可以修改代码了。

    修改代码注意事项

    • 代码风格保持一致SOFAJRaft 通过 Maven 插件来保持代码格式一致。在提交代码前，务必本地执行
    1. mvn clean compile
    • 补充单元测试代码
    • 新有修改应该通过已有的单元测试
    • 应该提供新的单元测试来证明以前的代码存在 bug，而新的代码已经解决了这些 bug您可以用如下命令运行所有测试：

    也可以通过IDE来辅助运行。

    其它注意事项

    • 请保持您编辑的代码的原有风格，尤其是空格换行等。
    • 对于无用的注释，请直接删除。
    • 对逻辑和功能不容易被理解的地方添加注释。
    • 及时更新文档
      修改完代码后，请按照如下格式执行命令提交所有修改到本地:
    1. git commit -am '(feat) 添加xx功能'

    提交代码到远程仓库

    在代码提交到本地后，就是与远程仓库同步代码了。执行如下命令提交本地修改到 github 上：

      提交合并代码到主干的请求

      在的代码提交到 GitHub 后，您就可以发送请求来把您改好的代码合入 SOFAJRaft 主干代码了。此时您需要进入您的 GitHub 上的对应仓库，按右上角的 pull request 按钮。选择目标分支，一般就是 master，系统会通知 SOFAJRaft 的人员， SOFAJRaft 人员会 Review 您的代码，符合要求后就会合入主干，成为 SOFAJRaft 的一部分。

      代码 Review

      在您提交代码后，您的代码会被指派给维护人员 Review，请耐心等待。如果在数天后，仍然没有人对您的提交给予任何回复，可以在 PR 下面留言，并 @ 对应的人员。

      对于代码 Review 的意见会直接备注到到对应 PR 或者 Issue。如果觉得建议是合理的，也请您把这些建议更新到您的补丁中。

      合并代码到主干