Git协作工作流

这篇文档是关于如何通过GitHub参与DevStream开发的流程。

第一步 - Fork 仓库

  1. 打开项目仓库: https://github.com/devstream-io/devstream
  2. 点击 Fork 按钮,从DevStream创建一个fork。

第二步 - Clone 仓库

  1. 定义一些基础的环境变量

请根据你的实际情况来设置值。

Bash

  1. export WORKING_PATH="~/gocode"
  2. export USER="daniel-hutao"
  3. export PROJECT="devstream"
  4. export ORG="devstream-io"
  1. Clone 仓库到你本地

    Bash

    1. mkdir -p ${WORKING_PATH}
    2. cd ${WORKING_PATH}
    3. # You can also use the url: git@github.com:${USER}/${PROJECT}.git
    4. # if your ssh configuration is proper
    5. git clone https://github.com/${USER}/${PROJECT}.git
    6. cd ${PROJECT}
    7. git remote add upstream https://github.com/${ORG}/${PROJECT}.git
    8. # Never push to upstream locally
    9. git remote set-url --push upstream no_push
  2. 确认你的远程设置是正确的

执行git remote -v 这个命令,你将看到如下输出:

Bash

  1. origin git@github.com:daniel-hutao/devstream.git (fetch)
  2. origin git@github.com:daniel-hutao/devstream.git (push)
  3. upstream https://github.com/devstream-io/devstream (fetch)
  4. upstream no_push (push)

第三步 - 分支代码保持同步更新

你经常需要更新你的本地代码,以便与上游保持同步。

Bash

  1. git fetch upstream
  2. git checkout main
  3. git rebase upstream/main

第四步 - 编码

首先,你需要拉一个新的分支,名字根据你自己的喜好而定。

Bash

  1. git checkout -b feat-xxx

然后开始编码吧。

第五步 - 提交&推送

Bash

  1. git add <file>
  2. git commit -s -m "some description here"
  3. git push -f origin feat-xxx

然后你就可以在GitHub上创建一个pr

附录

也欢迎阅读我们的博客-如何参与开源项目 - 细说 GitHub 上的 PR 全过程,了解更多 GitHub 协作流程,如解决冲突等。