Git使用规范流程

移动开发
团队开发中,遵循一个合理、清晰的Git使用流程,是非常重要的。否则,每个人都提交一堆杂乱无章的commit,项目很快就会变得难以协调和维护。下面是ThoughtBot 的Git使用规范流程。我从中学到了很多,推荐你也这样使用Git。

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

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

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

***步:新建分支

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

  1. # 获取主干***代码 
  2. $ git checkout master 
  3. $ git pull 
  4.  
  5. # 新建一个开发分支myfeature 
  6. $ git checkout -b myfeature 

第二步:提交分支commit

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

  1. $ git add --all 
  2. $ git status 
  3. $ git commit --verbose 

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

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

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

第三步:撰写提交信息

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

  1. Present-tense summary under 50 characters 
  2.  
  3. * More information about commit (under 72 characters). 
  4. * More information about commit (under 72 characters). 
  5.  
  6. http://project.management-system.com/ticket/123 

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

第四步:与主干同步

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

  1. $ git fetch origin 
  2. $ git rebase origin/master 

第五步:合并commit

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

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

  1. $ git rebase -i origin/master 

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

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

  1. pick 07c5abd Introduce OpenPGP and teach basic usage 
  2. pick de9b1eb Fix PostChecker::Post#urls 
  3. pick 3e7ee36 Hey kids, stop all the highlighting 
  4. pick fa20af3 git interactive rebase, squash, amend 
  5.  
  6. # Rebase 8db7e8b..fa20af3 onto 8db7e8b 
  7. # Commands: 
  8. #  p, pick = use commit 
  9. #  r, reword = use commit, but edit the commit message 
  10. #  e, edit = use commit, but stop for amending 
  11. #  s, squash = use commit, but meld into previous commit 
  12. #  f, fixup = like "squash", but discard this commit's log message 
  13. #  x, exec = run command (the rest of the line) using shell 
  14. # These lines can be re-ordered; they are executed from top to bottom. 
  15. # If you remove a line here THAT COMMIT WILL BE LOST. 
  16. # However, if you remove everything, the rebase will be aborted. 
  17. # 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)。

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

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

  1. # This is a combination of 3 commits. 
  2. # The first commit's message is: 
  3. Introduce OpenPGP and teach basic usage 
  4.  
  5. # This is the 2nd commit message: 
  6. Fix PostChecker::Post#urls 
  7.  
  8. # This is the 3rd commit message: 
  9. Hey kids, stop all the highlighting 

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

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

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

  1. # This is a combination of 3 commits. 
  2. # The first commit's message is: 
  3. Introduce OpenPGP and teach basic usage 
  4.  
  5. # This is the 2nd commit message: 
  6. Fix PostChecker::Post#urls 
  7.  
  8. # This is the 3rd commit message: 
  9. # Hey kids, stop all the highlighting 

squash和fixup命令,还可以当作命令行参数使用,自动合并commit。

  1. $ git commit --fixup   
  2. $ git rebase -i --autosquash  

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

第六步:推送到远程仓库

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

  1. $ git push --force origin myfeature 

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

第七步:发出Pull Request

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

责任编辑:倪明 来源: 阮一峰的博客
相关推荐

2015-08-07 10:22:45

Git规范流程管理策略

2015-12-30 10:29:40

Git协作流程详解

2021-02-26 07:35:57

Git版本工具

2020-08-14 08:00:39

Git数据层控制层

2021-09-13 06:43:36

UPS电源安装

2020-05-12 14:57:06

git commit代码前端

2023-09-04 13:55:44

分支masterhotfix

2010-08-12 17:34:19

网站运维流程规范

2021-08-09 06:57:41

CodeReview流程

2022-08-15 14:31:58

数据开发

2015-10-20 11:22:34

iOS开发Git

2018-07-10 11:05:18

开发者技能命令

2023-02-08 09:16:19

Git操作工厂类

2018-07-10 10:45:00

规范Commit项目

2009-06-23 09:25:01

谷歌人才流失

2020-09-28 12:39:44

代码规范管理

2017-02-08 13:33:34

AndroidJavaPhp

2009-08-25 10:27:29

IT管理流程企业内控JP1

2019-12-06 11:14:57

Git开发系统

2023-12-22 08:46:15

useEffectVueMobx
点赞
收藏

51CTO技术栈公众号