举例来自:https://github.com/vnpy/vnpy(作者为了这个项目,讲解得真是细致)
vn.py 使用 github 托管其源代码,如果希望贡献代码请使用 github 的 PR (Pull Request) 的流程:
- 创建 Issue – 对于较大的改动 (如新功能,大型重构等) 最好先开 issue 讨论一下,较小的 improvement (如文档改进,bugfix 等) 直接发 PR 即可
- Fork vn.py – 点击右上角 Fork 按钮
- Clone 你自己的 fork:
git clone https://github.com/$userid/vnpy.git
- 如果你的 fork 已经过时,需要手动 sync:https://help.github.com/articles/syncing-a-fork/
- 从 dev 创建你自己的 feature
branch:
git checkout -b $my_feature_branch dev
- 在 $my_feature_branch 上修改并将修改 push 到你的 fork 上
- 创建从你的 fork 的 $my_feature_branch 分支到主项目的 dev 分支的 [Pull Request] – 在此点击 compare across forks,选择需要的 fork 和 branch 创建 PR
- 等待 review, 需要继续改进,或者被 Merge!