为JianghuJS贡献代码

Fork代码

首先要登录您的GitHub账号,打开https://github.com/jianghujs/jianghu-init,点击该项目的fork按钮,将该项目的代码库复制到自己的账号下

WechatIMG138.png

修改代码

在自己的账号下修改复制的项目代码,添加新的功能或修复BUG,然后将修改提交到自己的分支(branch)上。

  • 基于master分支新建开发分支
  • 自测通过
  • 提交代码

发起pull request

在自己的账号下找到修改后的分支,点击“New pull request”按钮,把自己修改的内容提交给项目管理者,请求合并到原始项目的代码库中。

WechatIMG139.png

代码审核

项目管理者会收到你发起的pull request,查看你所修改的代码并决定是否接受。如果接受,则你所修改的代码将在原始项目的代码库中得到合并,成为大家可以使用的代码。

如果所提交的代码需要重新修改,项目管理者会评论你的代码的缺陷、问题以及需要修改的地方,你需要修改后重新提交pull request,直到你所提交的代码得到审核通过。

注意

需要注意的是,为了提高被接受合并的几率,还需要遵循一些代码风格、格式、注释、文档等约定。同时,如果涉及到大型的代码贡献,最好先开一个issue,与其他贡献者以及项目管理者进行讨论,并协商好代码贡献的计划与流程,以避免不必要的冲突和错误