Aofei Sheng

Git 使用规范流程

Published on

团队开发中,遵循一个合理、清晰的 Git 使用流程,是非常重要的。

否则,每个人都提交一堆杂乱无章的 Commit,项目很快就会变得难以协调和维护。

下面是 ThoughtBot 的 Git 使用规范流程。我从中学到了很多,推荐你也这样使用 Git。

第一步:新建分支

首先,每次开发新功能,都应该新建一个单独的分支(这方面可以参考《Git 分支管理策略》)。

# 获取主干最新代码
$ git checkout master
$ git pull
# 新建一个开发分支 myfeature
$ git checkout -b myfeature

第二步:提交分支 Commit

分支修改后,就可以提交 Commit 了。

$ git add --all
$ git status
$ git commit --verbose

git add 命令的 all 参数,表示保存所有变化(包括新建、修改和删除)。从 Git 2.0 开始,allgit add 的默认参数,所以也可以用 git add . 代替。

git status 命令,用来查看发生变动的文件。

git commit 命令的 verbose 参数,会列出 diff 的结果。

第三步:撰写提交信息

提交 Commit 时,必须给出完整扼要的提交信息,下面是一个范本。

Present-tense summary under 50 characters

* More information about commit (under 72 characters).
* More information about commit (under 72 characters).

http://project.management-system.com/ticket/123

第一行是不超过 50 个字的提要,然后空一行,罗列出改动原因、主要变动、以及需要注意的问题。最后,提供对应的网址(比如 Bug Ticket)。

第四步:与主干同步

分支的开发过程中,要经常与主干保持同步。

$ git fetch origin
$ git rebase origin/master

第五步:合并 Commit

分支开发完成后,很可能有一堆 Commit,但是合并到主干的时候,往往希望只有一个(或最多两三个)Commit,这样不仅清晰,也容易管理。

那么,怎样才能将多个 Commit 合并呢?这就要用到 git rebase 命令。

$ git rebase -i origin/master

git rebase 命令的 i 参数表示互动(Interactive),这时 Git 会打开一个互动界面,进行下一步操作。

下面采用 Tute Costa 的例子,来解释怎么合并 Commit。

pick 07c5abd Introduce OpenPGP and teach basic usage
pick de9b1eb Fix PostChecker::Post#urls
pick 3e7ee36 Hey kids, stop all the highlighting
pick fa20af3 git interactive rebase, squash, amend

# Rebase 8db7e8b..fa20af3 onto 8db7e8b
#
# Commands:
#  p, pick = use commit
#  r, reword = use commit, but edit the commit message
#  e, edit = use commit, but stop for amending
#  s, squash = use commit, but meld into previous commit
#  f, fixup = like "squash", but discard this commit's log message
#  x, exec = run command (the rest of the line) using shell
#
# These lines can be re-ordered; they are executed from top to bottom.
#
# If you remove a line here THAT COMMIT WILL BE LOST.
#
# However, if you remove everything, the rebase will be aborted.
#
# Note that empty commits are commented out

上面的互动界面,先列出当前分支最新的 4 个 Commit(越下面越新)。每个 Commit 前面有一个操作命令,默认是 pick,表示该行 Commit 被选中,要进行 Rebase 操作。

4 个 Commit 的下面是一大堆注释,列出可以使用的命令。

pick:正常选中
reword:选中,并且修改提交信息;
edit:选中,Rebase 时会暂停,允许你修改这个 Commit
squash:选中,会将当前 Commit 与上一个 Commit 合并
fixup:与 squash 相同,但不会保存当前 Commit 的提交信息
exec:执行其他 Shell 命令

上面这 6 个命令当中,squashfixup 可以用来合并 Commit。先把需要合并的 Commit 前面的动词,改成 squash(或者 s)。

pick 07c5abd Introduce OpenPGP and teach basic usage
s de9b1eb Fix PostChecker::Post#urls
s 3e7ee36 Hey kids, stop all the highlighting
pick fa20af3 git interactive rebase, squash, amend

这样一改,执行后,当前分支只会剩下两个 Commit。第二行和第三行的 Commit,都会合并到第一行的 Commit。提交信息会同时包含,这三个 Commit 的提交信息。

# This is a combination of 3 commits.
# The first commit's message is:
Introduce OpenPGP and teach basic usage

# This is the 2nd commit message:
Fix PostChecker::Post#urls

# This is the 3rd commit message:
Hey kids, stop all the highlighting

如果将第三行的 squash 命令改成 fixup 命令。

pick 07c5abd Introduce OpenPGP and teach basic usage
s de9b1eb Fix PostChecker::Post#urls
f 3e7ee36 Hey kids, stop all the highlighting
pick fa20af3 git interactive rebase, squash, amend

运行结果相同,还是会生成两个 Commit,第二行和第三行的 Commit,都合并到第一行的 Commit。但是,新的提交信息里面,第三行 Commit 的提交信息,会被注释掉。

# This is a combination of 3 commits.
# The first commit's message is:
Introduce OpenPGP and teach basic usage

# This is the 2nd commit message:
Fix PostChecker::Post#urls

# This is the 3rd commit message:
# Hey kids, stop all the highlighting

Pony Foo 提出另外一种合并 Commit 的简便方法,就是先撤销过去 5 个 Commit,然后再建一个新的。

$ git reset HEAD~5
$ git add .
$ git commit -am "Here's the bug fix that closes #28"
$ git push --force

squashfixup 命令,还可以当作命令行参数使用,自动合并 Commit。

$ git commit --fixup  
$ git rebase -i --autosquash

这个用法请参考这篇文章,这里就不解释了。

第六步:推送到远程仓库

合并 Commit 后,就可以推送当前分支到远程仓库了。

$ git push --force origin myfeature

git push 命令要加上 force 参数,因为 Rebase 以后,分支历史改变了,跟远程分支不一定兼容,有可能要强行推送(参见这里)。

第七步:发出 Pull Request

提交到远程仓库以后,就可以发出 Pull Request 到 Master 分支,然后请求别人进行代码 Review,确认可以合并到 Master。

(转自:阮一峰的网络日志