git commit 模板配置
来源:互联网 发布:ubuntu 17配置lamp 编辑:程序博客网 时间:2024/06/07 08:47
Git Log 之痛
在《The Art of Readable Code》这本经典书中,有个形象的比喻,衡量代码可读性的指标是阅读代码时每分钟的 WTF 次数,而在读 Git 提交历史的时候,不知道你有多少次爆粗口?不相信?你现在打开公司演进最快的项目,执行 git log,信息量过少甚至是误导的 commit message 非常常见,比如:
fix => 这到底是 fix 什么?为什么 fix?怎么 fix 的?update => 更新了什么?是为了解决什么问题?test => 这个最让人崩溃,难道是为了测试?至于为了测试而去提交一次代码么?
说不定,你在这种 commit message 中也贡献了一份力量呢。
解决问题
commit message包含三个部分,header, body和footer,其中header必须有,body和footer可以按情况省略。
type 字段
- feat:新功能(feature)
- fix:修补bug
- docs:文档(documentation)
- style: 格式(不影响代码运行的变动)
- refactor:重构(即不是新增功能,也不是修改bug的代码变动)
- test:增加测试
- chore:构建过程或辅助工具的变动
scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
也就是写用户会感觉到改变在哪个地方。
subject是 commit 目的的简短描述,不超过50个字符
- 以动词开头,使用第一人称现在时,比如change,而不是changed或changes
- 第一个字母小写
- 结尾不加句号(.)
Body 部分是对本次 commit 的详细描述,可以分成多行
- 使用第一人称现在时,比如使用change而不是changed或changes。
- 应该说明代码变动的动机,以及与以前行为的对比。
Footer
- 如果当前代码与上一个版本不兼容,则 Footer 部分以BREAKING CHANGE开头,后面是对变动的描述、以及变动理由和迁移方法。
- 关闭 Issue
修改git message默认编辑器
说了这么多写作规范,如果有个模板可以直接拷贝,是再好不过的。
使用模板之前,先对git message的默认编辑器做个修改,默认的是nano
,但这个软件我不会用。
用下面的命令,可以把默认编辑器改成vim
:
git config core.editor "vim"
另外,在这里也提供一个提交模板
curl
https://gist.githubusercontent.com/keniushadu/5c7de811bfd77c4cd9c5cd981d401d0d/raw/e048f777bd690767c13544b63f936c1a3219da5e/commit-msg.txt >> ~/.git-commit-template.txt
git config --global commit.template ~/.git-commit-template.txt
阅读全文
0 0
- git commit 模板配置
- 设置git commit 模板
- Git commit template 模板设定
- Git commit template 模板设定
- Git commit template 模板设定
- Git Commit Template 提交模板
- Git Commit Template 提交模板
- Git 提交模板 Commit Template
- Git commit template 模板设定, GIt file name too long
- git-commit
- git-commit
- git-commit
- git commit
- git commit
- git-commit
- git# commit
- git commit
- git commit
- Composer PHP依赖管理的新时代
- hadoop Configuration
- HTML学习笔记(三)——HTML样式
- 树形DP HDU 5416
- android monkey压力测试
- git commit 模板配置
- 一篇文章搞定矩阵相关概念及意义--通俗解释汇总
- 程序程序时报 Error installer failed ; 安装程序失败!
- 局域网络配置
- Tensorflow模型持久化与恢复
- DOS常用命令!
- c++ prime plus 第四章1~4
- TextRank, 关键词和句子抽取
- Osg 实例中用到的资源