Git工程开发实践（六）——Git工程实践扩展

Git工程开发实践（六）——Git工程实践扩展

一、Git提交日志规范

1、Git提交日志模板

Git支持对每次提交的日志信息进行规范，可以通过设置提交模板实现。
建立一个gitCommitTemplate文件，内容为：

目前成都创新互联公司已为上1000家的企业提供了网站建设、域名、虚拟空间、网站托管、服务器托管、企业网站设计、麻阳网站维护等服务，公司将坚持客户导向、应用为本的策略，正道将秉承"和谐、参与、激情"的文化，与客户和合作伙伴齐心协力一起成长，共同发展。

#commit message包含三部分，header, body和footer，其中header必选，body和footer可选。
# type(): 

#

#

 Revert撤销操作
如果当前commit用于撤销以前的commit，则必须以revert:开头，后面跟着被撤销Commit的Header。

revert: feat(pencil): add 'graphiteWidth' option
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.

Body部分的格式是固定的，必须写成 This reverts commit commit_id. ，其中的hash是被撤销commit的 SHA 标识符 。 如果当前commit与被撤销的commit，在同一个发布（release）里面， 那么都不会出现在Change log 里面。如果两者在不同的发布，那么当前commit，会出现在Change log的Reverts小标题下面。

2、Git提交日志模板设置

设置当前分支的提交模板

git config commit.template [模板文件名]   
git config commit.template gitcommit_template

设置全局的提交模板

git config --global commit.template [模板文件名]   
git config --global commit.template gitcommit_template

设置文本编辑器

git config --global core.editor [编辑器名称] 
git config --global core.editor vim

3、Git提交日志填写

使用git commit -a提交时，Git会用设置的编辑器打开设置的提交日志模板，然后按照格式添加相应的备注，保存提交到远程分支。

二、Git代码统计

Git可以通过对log的分析进行代码统计。
git log参数说明：
--author
指定作者
--stat 显示每次更新的文件修改统计信息，会列出具体文件列表
--shortstat 统计每个commit 的文件修改行数，包括增加，删除，但不列出文件列表：
--numstat 统计每个commit 的文件修改行数，包括增加，删除，并列出文件列表：
-p 选项展开显示每次提交的内容差异，用 -2 则仅显示最近的两次更新，例如：git log -p -2
--name-only 仅在提交信息后显示已修改的文件清单
--name-status 显示新增、修改、删除的文件清单
--abbrev-commit 仅显示SHA-1的前几个字符，而非所有的40个字符
--relative-date 使用较短的相对时间显示
--graph 显示ASCII图形表示的分支合并历史
--since 限制显示输出的范围，
例如：git log --since=2.weeks 显示最近两周的提交
选项说明
-(n) 仅显示最近的 n 条提交
--since, --after 仅显示指定时间之后的提交。
--until, --before 仅显示指定时间之前的提交。
--author 仅显示指定作者相关的提交。
--committer 仅显示指定提交者相关的提交。

    git log --until=1.minute.ago // 一分钟之前的所有 log 
    git log --since=1.day.ago //一天之内的log 
    git log --since=1.hour.ago //一个小时之内的 log 
    git log --since=`.month.ago --until=2.weeks.ago //一个月之前到半个月之前的log 
    git log --since ==2013-08.01 --until=2013-09-07 //某个时间段的log   
    git blame //看看某一个文件的相关历史记录
    git blame index.html --date short

--pretty 使用其它格式显示历史提交信息。可用的选项包括 oneline，short，full，fuller 和 format（后跟指定格式）。
git log --pretty=oneline ;
git log --pretty=short ;
git log --pretty=full ;
git log --pretty=fuller
--pretty=tformat: 可以定制要显示的记录格式，便于后期编程提取分析。
git log --pretty=format:""%h - %an, %ar : %s""
%H 提交对象（commit）的完整哈希字串
%h 提交对象的简短哈希字串
%T 树对象（tree）的完整哈希字串
%t 树对象的简短哈希字串
%P 父对象（parent）的完整哈希字串
%p 父对象的简短哈希字串
%an 作者（author）的名字
%ae 作者的电子邮件地址
%ad 作者修订日期（可以用 -date= 选项定制格式）
%ar 作者修订日期，按多久以前的方式显示
%cn 提交者(committer)的名字
%ce 提交者的电子邮件地址
%cd 提交日期
%cr 提交日期，按多久以前的方式显示
%s 提交说明
git log --author="username" --pretty=tformat: --numstat | awk '{ add += $1; subs += $2; loc += $1 - $2 } END { printf "added lines: %s, removed lines: %s, total lines: %s\n", add, subs, loc }'
统计用户名为username的开发者增删的代码行数
git log --author="$(git config --get user.name)" --pretty=tformat: --numstat | gawk '{ add += $1 ; subs += $2 ; loc += $1 - $2 } END { printf "added lines: %s removed lines : %s total lines: %s\n",add,subs,loc }'
统计当前用户增删的代码行数
git log --format='%aN' | sort -u | while read name; do echo -en "$name\t"; git log --author="$name" --pretty=tformat: --numstat | awk '{ add += $1; subs += $2; loc += $1 - $2 } END { printf "added lines: %s, removed lines: %s, total lines: %s\n", add, subs, loc }' -; done
统计每个开发者增删的代码行数
git log --pretty='%aN' | sort | uniq -c | sort -k1 -n -r | head -n 5
统计仓库提交者排名前5的开发者
git log --pretty='%aN' | sort -u | wc -l
统计仓库贡献者的数量
git log --oneline | wc -l
仓库提交数量统计

三、Git代码托管工程实践

1、Git代码托管简介

目前主流的Git在线代码托管工具如下：
GitHub：https://github.com
GitHub是一个面向开源及私有软件项目的托管平台。
Gitee(码云)：https://gitee.com
中国本土的在线代码托管协作开发平台。
GitLab:https://gitlab.com
GitLab是一个用于仓库管理系统的开源项目，支持无 限公有项目和私有项目，支持在局域网内使用GiLab CE搭建代码托管服务器。

2、Pull Request机制

Pull Request是集成管理者工程流程在GitHub上的工程实践，是开发者使用GitHub进行协作开发的一种通知机制，让开发者通知项目成员一个功能已经完成。如果功能分支开发完毕，开发者使用GitHub账号提交一个Pull Request，通知所有参与者需要进行代码审查，并将代码并入master分支。Pull Request还提供了专注于某个提交功能的讨论版。
Pull Request的工作流程如下：
A、开发者从某个项目的官方仓库Fork一份拷贝到自己GitHub账户，此时开发者的GitHub账户会有一份项目官方仓库的拷贝。
B、开发者将自己远程仓库的项目副本克隆到本地
C、开发者在自己本地仓库为某个功能创建一个专门的分支，并完成功能开发。
D、开发者将开发完成的功能分支推送到自己GitHub账户的公开仓库。
E、开发者用GitHub发起一个Pull Request。
F、其他团队成员审查代码，讨论并且做出修改。
G、项目维护者将功能并入官方仓库，然后关闭Pull Request。

3、Pull Request示例

scorpio是HyperLedger Fabric的开发者，Mary是HyperLedger Fabric项目的维护者。HyperLedger Fabric在GitHub的官方仓库地址如下：
https://github.com/hyperledger/fabric
A、将HyperLedger Fabric项目官方仓库fork到自己的GHub账户。
为了参与HyperLedger Fabric项目，scorpio首先要fork HyperLedger Fabric项目在GitHub的官方仓库。scorpio需要注册登录 GitHub，找到HyperLedger Fabric的官方仓库，点击Fork按钮。

此时，GitHub会在scorpio账户中派生一份HyperLedger Fabric的官方仓库的拷贝。
B、将自己GitHub账户中的HyperLedger Fabric项目副本克隆到本地。
scorpio需要将刚刚fork的GitHub仓库克隆到本地。
git clone https://github.com/scorpiostudio/fabric
git clone自动创建一个名为origin的远端仓库，指向scorpio自己GitHub账户中的fabric仓库（https://github.com/scorpiostudio/fabric）。
C、在本地仓库创建feature分支
在进行开发前，scorpio需要创建一个新的功能分支some-feature。
git checkout -b some-feature
D、在新建的feature分支上完成功能开发
scorpio在当前分支some-feature上进行功能开发，最终完成。
E、将本地仓库开发的功能分支推送到开发者自己的GitHub账户的远程仓库。
在完成some-feature功能开发后，scorpio将some-feature分支推送到自己的GitHub仓库（https://github.com/scorpiostudio/fabric）上。
git push origin some-feature
此时，scorpio开发的some-feature功能就可以被其他人看到。
F、开发者在GitHub上的项目官方仓库创建一个Pull Request
scorpio需要找到HyperLedger Fabric项目的官方仓库（https://github.com/hyperledger/fabric），点击项目简介下的New pull request按钮，使用自己的GitHub帐号创建一个Pull Request。

scorpio的仓库会被默认设置为源仓库（head fork），询问指定源分支（compare）、目标仓库（base fork）和目标分支（base）。

scorpio想要将自己开发的some-feature功能并入主代码库，所以源分支是scorpio的some-feature分支，目标仓库就是HyperLedger Fabric项目的官方仓库，目标分支为master。scorpio需要提供一个Pull Request的标题和简介。
在scorpio创建一个Pull Request后，GitHub会给HyperLedger Fabric项目的维护者Mary发一个通知。
G、项目官方仓库的维护者审查开发者提交的功能分支
Mary可以在自己的GitHub仓库下的Pull Request选项卡中看到所有的 Pull Request。点击scorpio的Pull Request会显示Pull Request的简介、some-feature分支的提交历史以及包含的更改。
H、项目官方仓库的维护者接受开发折提交的功能分支并关闭Pull Request
如果Mary认为some-feature分支已经可以合并，只需点击Merge Pull Request按钮来通过当前的Pull Request，将scorpio提交的some-feature分支并入HyperLedger Fabric官方仓库的master分支。
如果Mary发现了scorpio代码中的一个小bug，需要scorpio在合并前修复。Mary可以评论整个Pull Request，也可以评论some-feature分支中某个特定的提交。
为了修复错误，scorpio在自己本地仓库some-feature分支后面添加了另一个提交，并将它推送到了GitHub远程仓库。此时修复bug的提交被自动添加到原来的Pull Request后面，Mary可以在评论下方再次审查scorpio的修改。
最终，经过多次修改后，Mary接受了scorpio提交的功能，将some-feature分支并入HyperLedger Fabric官方仓库master分支，并关闭scorpio创建的Pull Request。现在some-feature功能现在已经整合到了HyperLedger Fabric项目中，其他在master分支上工作的开发者可以使用标准的git pull命令将上述修改拉取到自己的本地仓库。

4、Merge Request机制

Merge Request是集成管理者工程流程在GitLab上的工程实践。
用Admin或Owner或Master账号登录，打开指定project -> Settings -> Repository -> Protected Branches，选择要protect的branch （支持wildcard）：
要求每个人都要通过Merge Request才能合并代码进入public branch：选择”Allowed to merge”为”Developers + Masters”，选择”Allowed to push” 为”No one“。

Merge Request工作流程如下：
A、从项目的官方仓库fork一份拷贝到GitLab的个人账户。此时个人账户有一份项目官方仓库的拷贝。
B、将个人账户的项目仓库克隆到本地
C、在本地仓库创建一个新的本地分支，进行任务开发，开发完成后推送到个人GitLab账户的远程仓库，此时Git会提示进行Merge Request。

D、开发者登录GitLab账户，在fork的官方项目副本上发起Merge Request。打开项目，点击右侧的Create merge request。

选择Source branch和Target branch，Source branch分支为个人GitLab账户中的远程仓库分支，Target branch分支为GitLab官方仓库的分支

点击”Compare branches and continue“

填写标题和表述信息。
选择Assignee（指派给谁） （不要选择Assign to me）
如果是临时branch，勾选“Remove source branch when merge request is accepted”
检查无误后，点击“Submit merge request”按钮。
如果发起Merge Request后，在本Merge Request关闭前，继续往source branch分支push代码，后续commit也会被自动包含在本Merge Request里。
E、其他人进行代码审查，通过Merge Request。
被指派者登录GitLab个人账户，点击由上角Merge Request，查看当前的Merge Request任务。

点击Merge Request任务进入

点击Commit查看详细信息
点击Changes查看具体的改动
写comment，并和代码提交者讨论。
审查通过后，点击”Merge”按钮
如果审查不通过，写清楚comment，并在和代码提交者讨论后，要求其进行修改。
F、结果查看
点击GitLab上的项目官方仓库，选择相应的分支，可以看到，开发者Merge Request申请合并的分支已经并入了官方仓库。

上述实验在GitLab CE（社区版）中进行，因此实际上发起Merge Request申请的人或是其他人，只要具有Merge权限都可以进行Merge。
GitLab CE（社区版）发起Merge Request时，所有具备Merge的项目成员都可以Merge；
GitLab EE（企业版）加入了权限管理审批机制（Merge Request Approvals），只有指派的成员才可以Merge。

5、选择分支策略的原则

选择分支策略的原则：
A、始终保持master处在可发布状态
B、始终保持构建处在成功状态
C、降低代码合并的复杂度和风险
D、降低团队沟通成本
E、符合团队的现状

6、代码审查的原则

代码审查的原则：
A、不要既当运动员，又当裁判员。
B、审查代码是否满足功能、规范、测试结果、测试覆盖等。
C、借助自动化代码审查工具来提升代码审查的效率。
D、审查合格才允许并入public branch，不合格的代码退回重新修改。
E、不怕犯错，但不要犯重复的错。
F、提交审查前，自己先检查一遍。
G、鼓励使用同行评审（Peer Review）而不是上下级评审，鼓励积极反馈、互动。
H、评审对事不对人，多建议，不批评
I、评审过程对reviewer和代码提交者双方都是一个学习提升的过程，保持开放的心态，相互学习，共同成长。

四、Git GUI工具

GUI Clients：https://www.git-scm.com/downloads/guis
部分提供免费版的Git客户端如下：
SourceTree：Windows，Mac（支持Git Flow）
GitHub Desktop：Windows，Mac（支持Pull Request）
TortoiseGit：Windows
Git Extensions：Linux, Mac, Windows
GitKraken：Linux, Mac, Windows
SmartGit：Linux, Mac, Windows(支持Git Flow,Pull Request)
CodeReview：Linux, Mac, Windows
GitEye：Linux, Mac, Windows
GitGUI： Linux, Windows(Git官方GUI客户端)

五、主流IDE对Git的支持

目前软件开发的主流IDE通过插件方式支持Git。
Eclipse ：通过Egit插件提供Git集成支持。
Visual Studio：通过Git Integration、GitHub Extension等Git插件提供Git集成支持。
QtCreator：通过Git插件提供Git集成支持(QtCreator高版本支持GitK，GitGUI)。
IntelliJ IDEA：通过GitXXX插件提供Git集成支持。

文章名称：Git工程开发实践（六）——Git工程实践扩展
当前网址：http://bzwzjz.com/article/joohcj.html