zoukankan      html  css  js  c++  java
  • 使用 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。

  • 相关阅读:
    jQuery使用手册
    数据结构排序算法总结(转)
    VS2008升级激活码
    用VS2005建立解决方案
    backgroundposition 用法详细介绍
    CSS布局口诀,学ccs不再难
    Web.Config文件中SQLServerExpress数据库连接配置解释(转)
    css
    2011,我来了!
    Ajax验证用户名是否存在
  • 原文地址:https://www.cnblogs.com/ssaylo/p/13964251.html
Copyright © 2011-2022 走看看