id: version-3.1.0_Chinese-git-workflow title: Git Workflow original_id: git-workflow

对于开发者

  1. 将SINGA Github repository fork到你自己的Github账户。

  2. 从你自己的git仓库中clone repo (short for repository):

    git clone https://github.com/<Github account>/singa.git
git remote add upstream https://github.com/apache/singa.git

  3. 创建一个新的分支（例如 feature-foo 或 fixbug-foo），在这个分支上工作并提交你的代码:

    git checkout dev
git checkout -b feature-foo
# write your code
git add <created/updated files>
git commit

    commit信息应包括：

    • 一个概括性的标题。
    • 详细的描述。如果提交是为了修复bug，描述中最好包括问题的简短复现；如果是新功能，可以描述新功能的动机/目的。

    如果您的分支有很多小的commit，您需要通过:

    git rebase -i <commit id>

    你可以压制和重写提交的内容。

  4. 当你在写代码的时候，SINGA的dev分支可能已经被别人更新了；在这种情况下，你需要拉取最新的dev分支：

    git checkout dev
git pull upstream dev:dev

  5. 将feature-foo rebase到dev分支上，并将提交的内容推送到自己的Github账户（你刚刚创建的新分支），rebase操作是为了清理提交历史。提交当前工作后，应执行以下 git 指令：

    git checkout feature-foo
git rebase dev
git push origin feature-foo:feature-foo

    Rebase命令的操作步骤如下: “这个操作的工作原理是进入到两个分支（你所在的分支和你要rebase的分支）的共同来源 -> 获取你所在分支的每次commit所引入的差异 -> 将这些差异保存到临时文件中 -> 将当前分支重置为与你要rebase的分支相同的commit -> 最后依次修改每个差异。”

    因此，执行后，你还是在特性分支上，但你自己的提交ID/hash被改变了，因为diffs是在rebase时提交的；而且你的分支现在有来自dev分支和你自己分支的最新代码。

  6. 在 Github 网站上创建一个针对 apache/singa dev分支的pull request（PR）。如果你想通知其他在相同文件上工作过的贡献者，你可以在Github上找到文件，然后点击 “Blame”，就可以看到最后修改代码的人的逐行注释。然后，你可以在PR描述中加上@username，就可以立即ping到他们。请说明该贡献是你的原创作品，并且你在项目的开源许可下将该作品授权给项目。你的新分支的进一步提交（例如，bug修复）将由Github自动添加到这个pull request中。

  7. 接下来等待committer审核PR。在这段时间里，SINGA的dev可能已经被其他人更新了，这时你需要合并最新的dev来解决冲突。有些人将PR重新rebase到最新的dev上，而不是合并。但是，如果其他开发者获取这个PR来添加新的功能，然后再发送PR，那么rebase操作会在未来的PR中引入重复的提交（不同的哈希）。关于何时避免使用rebase的细节，请参见The Golden Rule of Rebasing。另一种简单的更新PR的方法（修复冲突或提交错误）是，从Apache SINGAS repo的最新开发分支中checkout出一个新的分支，复制并粘贴更新/添加的代码，然后commit并发送一个新的PR。

对于Committers

Committer可以将PR合并到上游 repo 的 dev 分支。在合并每一个PR之前，提交者应该做到：

  • 检查commit信息(内容和格式)
  • 检查对现有代码的修改，API的变化应该被记录下来
  • 检查Travis测试结果，检查代码/文档格式和单元测试。

合并PR的方式有两种:

  • 在Github上，按照说明将你的Apache账户与Github账户链接，之后你就可以直接在GitHub上合并PR了。

  • 通过命令行合并pull request到https://github.com/apache/singa/pull/xxx，应执行以下指令：

    git clone https://github.com/apache/singa.git
git remote add asf https://gitbox.apache.org/repos/asf/singa.git
git fetch origin pull/xxx/head:prxxx
git checkout dev
git merge --no-ff prxxx
git push asf dev:dev

    不要使用rebase来合并PR，并禁用fast forward。