Git 使用规范流程

团队开发中,遵循一个合理、清晰的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).

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个命令当中,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。

(完)

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
### 回答1: 随着软件研发公司的发展,代码管理和版本控制变得越来越重要。Git是目前最受欢迎的代码版本控制系统之一,是许多软件研发公司使用的首选工具。而要确保一个团队使用Git时不产生混乱,需要制定Git使用规范。以下是软件研发公司Git使用规范的几个关键点: 1. 分支管理 在团队开发中,Git 的分支管理功能可以使开发人员轻松地协作,同时确保代码合并到主分支时不会出现不可预料的问题。因此,开发团队应该确立一个分支合并政策,并在项目启动时详细讨论和确定。 2. 提交规则 Git的提交规范可以使团队更好的管理和控制代码,提高代码质量。开发团队应该制定提交信息模板并遵循一定的格式,例如使用 type(scope): subject 的格式。 3. 代码审查 代码审查可确保代码更加健壮且易于维护,同时它也会帮助开发人员更多地获取他人的专业知识。开发团队可以设立代码审查流程,并确保每个提交都得到同行的确认。 4. 版本管理 如上所述,一个好的Git使用规范可以帮助项目开发人员更好的管理代码,特别是版本控制。开发团队应该在代码库中设置标签,并确保所有代码的历史版本都得到备份。 综上所述,Git使用规范对软件研发公司非常重要。它可以使开发团队更好地管理代码,避免团队成员之间的混乱,同时确保代码的质量和安全。通过严格遵守这些规范,软件研发公司可以确保开发出的软件更加可靠和高效。 ### 回答2: 软件研发公司Git使用规范需要遵循以下原则: 1.分支策略:应该使用Git Flow分支管理工作流,将开发、测试和发布过程分开,并建立主分支和开发分支。 2.Commit信息:每个commit都应该有有意义的注释。清楚地描述了变更的内容。 3.Merge流程使用rebase的方式进行merge,保持commit的线性。 4.Pull Request审查:对所有分支合并进行审查,确认是否应该合并进产品或特性分支。 5.版本控制公开:将代码仓库公开,使用标签对代码版本进行版本控制,并正确地管理文件和文件夹结构。 6.频繁地推送:推送代码到远程代码库,确保所有人都在同一个页面上,并及时解决冲突。 7.测试:在主分支前进行单元测试,并及时修复Bug。 8.使用releases:代表具体版本的标记的归档分支。 9.合并冲突:如果出现冲突,要明确已经冲突的部分,采用最好的方法解决。 在软件开发的整个过程中,遵循严格的Git使用规范可以帮助开发团队更加高效地合作,减少几个层面的风险。 ### 回答3: 软件研发公司git使用规范需要遵循以下几点: 一、版本控制 1、在开发新功能或修复bug前,应该从远程仓库中将最新代码拉取到本地,并确保本地仓库与远程仓库同步。 2、开发新功能或修复bug时,应该创建新分支进行开发或修复,不应该直接在主分支(如master)上进行修改。 3、在开发过程中,应该频繁进行代码提交,确保代码的可追溯性。 二、分支管理 1、在创建新功能或修复bug的分支时,应该遵循命名规范,名称应该描述清楚该分支的作用,如“feature/login”、“bugfix/login”。 2、当功能或修复完成后,应该将该分支合并到主分支上进行代码同步。 3、删除无用的分支,以免造成仓库杂乱不堪。 三、代码规范 1、遵循团队的代码规范使用已定制好的代码格式,确保代码风格一致。 2、代码注释应该充分、清晰明了,便于代码审核和其他开发人员理解。 四、实时同步 1、所有开发人员应该时刻保持远程仓库与本地仓库的同步,避免代码冲突和版本受损。 2、每天结束前,应该将本地代码提交到远程仓库中,确保代码安全。 以上是软件研发公司git使用规范的主要内容,遵循这些规范可以有效地提高代码管理的效率和质量。同时,在实际开发中应该灵活运用这些规范,根据不同项目的需求进行调整。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值