使用 git 的正確姿勢


文章主要參考ruanyf老師的博客,自己學習記錄的筆記。

眼下最流行的"版本管理系統",肯定就是git了,Linus真的牛掰。

linus十天寫出git...

Commit 規范

commit message格式

<type>(<scope>): <subject>

type(必須)

用於說明git commit的類別,只允許使用下面的標識。

  • feat:新功能(feature)。
  • fix/to:修復bug,可以是QA發現的BUG,也可以是研發自己發現的BUG。
    • fix:產生diff並自動修復此問題。適合於一次提交直接修復問題
    • to:只產生diff不自動修復此問題。適合於多次提交。最終修復問題提交時使用fix
  • docs:文檔(documentation)。
  • style:格式(不影響代碼運行的變動)。
  • refactor:重構(即不是新增功能,也不是修改bug的代碼變動)。
  • perf:優化相關,比如提升性能、體驗。
  • test:增加測試。
  • chore:構建過程或輔助工具的變動。
  • revert:回滾到上一個版本。
  • merge:代碼合並。
  • sync:同步主線或分支的Bug。

scope(可選)

scope用於說明 commit 影響的范圍,比如數據層、控制層、視圖層等等,視項目不同而不同。

例如在Angular,可以是location,browser,compile,compile,rootScope, ngHref,ngClick,ngView等。如果你的修改影響了不止一個scope,你可以使用*代替。

subject(必須)

subject是commit目的的簡短描述,不超過50個字符。

建議使用中文(感覺中國人用中文描述問題能更清楚一些)。

耗子叔建議 commit這些全部用英文寫,鍛煉自己的英文能力

  • 結尾不加句號或其他標點符號。

  • 根據以上規范git commit message將是如下的格式:

    fix(DAO):用戶查詢缺少username屬性 
    feat(Controller):用戶查詢接口開發
    

好處

編碼規范、流程規范在軟件開發過程中是至關重要的,它可以使我們在開發過程中少走很多彎路。Git commit規范也是如此,確實也是很有必要的,幾乎不花費額外精力和時間,但在之后查找問題的效率卻很高。作為一名程序員,我們更應注重代碼和流程的規范性,永遠不要在質量上將就。

分支管理策略

1. 主分支Master

首先,代碼庫只能有一個且僅有一個主分支,所有提供給用戶使用的正式版本,都在這個主分支上發布。

bg2012070503

Git主分支的名字,默認叫做Master。它是自動建立的,版本庫初始化后,默認就是在主分支上進行開發。

現在 github 新建的好像叫做 main 分支了

2. 開發分支

主分支只用來分布重大版本,日常開發應該在另一條分支上完成。我們把開發用的分支,叫做Develop。

bg2012070504

這個分支可以用來生成代碼的最新隔夜版本(nightly)。如果想正式對外發布,就在Master分支上,對Develop分支進行"合並"(merge)。

Git創建Develop分支:

git checkout -b develop master

將Develop分支發布到主Master分支:

  # 切換到Master分支
  git checkout master

  # 對Develop分支進行合並
  git merge --no-ff develop

這里稍微解釋一下,上一條命令的--no-ff參數是什么意思。默認情況下,Git執行"快進式合並"(fast-farward merge),會直接將Master分支指向Develop分支。

bg2012070505

使用--no-ff參數后,會執行正常合並,在Master分支上生成一個新節點。為了保證版本演進的清晰,我們希望采用這種做法。

img

3. 臨時性分支

前面講到版本庫的兩條主要分支:Master和Develop。前者用於正式發布,后者用於日常開發。其實,常設分支只需要這兩條就夠了,不需要其他了。

但是,除了常設分支以外,還有一些臨時性分支,用於應對一些特定目的的版本開發。臨時性分支主要有三種:

  * 功能(feature)分支

  * 預發布(release)分支

  * 修補bug(fixbug)分支

這三種分支都屬於臨時性需要,使用完以后,應該刪除,使得代碼庫的常設分支始終只有Master和Develop。

4. 功能分支

接下來,一個個來看這三種"臨時性分支"。

第一種是功能分支,它是為了開發某種特定功能,從Develop分支上面分出來的。開發完成后,要再並入Develop。

bg2012070507

功能分支的名字,可以采用feature-*的形式命名。

創建一個功能分支:

  git checkout -b feature-x develop

開發完成后,將功能分支合並到develop分支:

  git checkout develop

  git merge --no-ff feature-x

刪除feature分支:

  git branch -d feature-x

5. 預發布分支

第二種是預發布分支,它是指發布正式版本之前(即合並到Master分支之前),我們可能需要有一個預發布的版本進行測試。

預發布分支是從Develop分支上面分出來的,預發布結束以后,必須合並進Develop和Master分支。它的命名,可以采用release-*的形式。

創建一個預發布分支:

  git checkout -b release-1.2 develop

確認沒有問題后,合並到master分支:

  git checkout master

  git merge --no-ff release-1.2

  # 對合並生成的新節點,做一個標簽
  git tag -a 1.2

再合並到develop分支:

  git checkout develop

  git merge --no-ff release-1.2

最后,刪除預發布分支:

  git branch -d release-1.2

6. 修補bug分支

最后一種是修補bug分支。軟件正式發布以后,難免會出現bug。這時就需要創建一個分支,進行bug修補。

修補bug分支是從Master分支上面分出來的。修補結束以后,再合並進Master和Develop分支。它的命名,可以采用fixbug-*的形式。

bg2012070508

創建一個修補bug分支:

  git checkout -b fixbug-0.1 master

修補結束后,合並到master分支:

  git checkout master

  git merge --no-ff fixbug-0.1

  git tag -a 0.1.1

再合並到develop分支:

  git checkout develop

  git merge --no-ff fixbug-0.1

最后,刪除"修補bug分支":

  git branch -d fixbug-0.1

Git 使用規范流程

團隊開發中,遵循一個合理、清晰的Git使用流程,是非常重要的。

否則,每個人都提交一堆雜亂無章的commit,項目很快就會變得難以協調和維護。bg2015080501

第一步:新建分支

首先,每次開發新功能,都應該新建一個單獨的分支。

# 獲取主干最新代碼
$ 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).

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會打開一個互動界面,進行下一步操作。

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

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

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。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM