團隊開發中,遵循一個合理、清晰的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開始,all是 git 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).
第一行是不超過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。
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個命令當中,squash和fixup可以用來合併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
squash和fixup命令,還可以當作命令列參數使用,自動合併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。