Why

在接手新项目时候

你希望看到git的commit记录是这样的?
还是这样的?? WTF!?

听说鱼的记忆只有7秒钟, 但是我看人的记忆也不怎么样,反正我能记清楚之前写的代码细节,最多只有7天
那么问题来了,git提交记录如果不能提供有效信息,项目上线一段时间之后出bug需要修复,或者临时接手其他同事项目时,看到git记录里只有一堆的Update心情如何?

What

git 提交commit部分,规范模板,提供尽量详细的信息
用最少的话把事说清楚,格式统一,方便快速阅读和定位
不用想太多，简洁操作 , 无需额外增加大量时间
与gitlab数据issue关联，获取更多信息, 例如当时这个需求细节是怎么样的?或者客户提出了什么样的奇葩要求,才有这段shi~一样的代码?

How

复制模板(之后分享这个文件)到你的home目录.
执行命令: git config --global commit.template ~/.git-commit-template
看一下是否正确配置了: git config commit.template
每次体检时简单修改一下即可,一般不会超过1分钟
举一些完成的例子:
1.: (后台MGTOMedia/AppBundle/Controller/NewsController.php) issue#17
2.: (MGTOMedia/CommonBundle/Services/ElasticSearchService.php) issue#18
3.: (尝试composer引入phpoffice)composer 引入phpOffice读取doc文件遇到一些问题
4.: (新增文档) 新增Ela搜索News的Mapping文档和搜索使用的query例子伪代码
如果你针对自己的模板有什么改进,请记得分享给我一份!
我的文档范本: (你看,真的很简单,只有3行)

: (影响范围) # 解释为什么要做这些改动issue #?

How good

总结我个人在2018年下半年使用情况来看,这个确实是有必要的.几乎不花费额外精力和时间,但是之后查找问题效率很高.
可以通过 issue#? 关联到gitlab. 这样如果之前关于每个需求细节都在issue中讨论的话,那么这几乎就是一套非常完整而且有细节,有代码的项目文档了.也不需要额外花费时间来写文档. 我知道写文档这工作基本没人愿意做. 等到真的需要的时候,也没人能记得清楚到底该写什么了.
写清关联信息，方便事后查找，同事协作
别给自己挖坑，提高问题解决的效率
合作的时候能快速理解一些设计的原因
出问题的时候可以快速定位到位置，并且理解逻辑快速修正
你不能确保自己能在一个月后，自己还能记住项目的每个细节

最后,附上思维导图(2.2MB)

- END -

git 提交_GIT提交规范的使用和总结相关推荐

from 下拉框多个值提交_Git提交规范
规范的作用大多数情况下,看提交历史的人跟提交代码的人都不是同一个人,当别人阅读你的提交历史时,他很可能是不知道具体代码细节的,你如何在最短的时间内让他一眼知道每次提交的意义: 每次提交影响的具体范围 ...
ecplise git修改提交信息_Git提交信息规范化
目的统一团队Git Commit标准,便于后续代码review.版本发布.自动化生成change log: 可以提供更多更有效的历史信息,方便快速预览以及配合cherry-pick快速合并代码: 团 ...
git-cz git commit 定制提交规范
git commit规范定制步骤1: 安装 commitizen cz-emoji(表情符) npm i commitizen cz-emoji --save 步骤2:打开package.json ...
开发中git提交代码注释规范
1.1 简述 git commit -m "本次提交注释信息规范" 1.2 注释分类 feat: 修改/增加新功能 fix: 修改bug的变更 docs: 文档相关变更 style ...
git 查询提交明细_Git [提交记录查看、提交、变基](I)
查看提交记录终端命令 git log:列出历史提交记录; 记录查看 git log --oneline:查看历史记录的简洁的版本; 简洁记录查看提交提交规范 feat: 新功能 fix: 修复问 ...
git 将暂存区文件提交_Git知识
Git 快速开始一. 下载git 地址 : https://git-scm.com/downloads 二.git基础 1.git config 相关命令 # local 只对某一个仓库有效git ...
git clone 某次提交前代码_git提交代码常用命令
1.在网页上fork中心仓到自己私有仓 2.本地clone自己的私有仓:git clone 自己的私有仓地址 3.本地添加中心仓分支地址: git remote add upstream ssh:// ...
git 将暂存区文件提交_git 暂存区
一.Git基本工作流程 1.初始化一个仓库 git init git clone git仓库分为两种情况: 第一种是在现有项目或目录下导入所有文件到 Git 中: 第二种是从一个服务器克隆一个现有 ...
git 将暂存区文件提交_git文件状态，暂存与提交
git中文件的状态有两种:已跟踪或者未跟踪. 从现有目录中创建git仓库 git init git仓库(repository),也叫做版本库.使用git的目的是管理项目,并且保存一些随时间变化的文件. ...

git 提交_GIT提交规范的使用和总结

Why

What

How

How good

最后,附上思维导图(2.2MB)

git 提交_GIT提交规范的使用和总结相关推荐

最新文章

热门文章