commit message 规范

(这段时间做项目发现,多人合作时或者查看自己修改的以前版本,即使描述很清晰,
一天提交很多版本的情况下,也要逐一仔细查看变化,不是很直观)
下面分享下这两天用的Commit message 的格式:

1.对比

before after after
image
image
image

2.前提:

每次本地代码改动提交到远程,需要注明提交说明,否则不允许提交到远程

git commit -m "hello word" // -m: 指定hello word

提交多行信息:

git commit // 跳出文本编辑器,写多行信息

3.commit message 格式

每次提交,包括三个部分: header, body, footer

<type>(<scope>): <subject> // 必须

                <body> // 可省略

                <footer> // 可省略

解释:

type: 提交类别(下面基本会覆盖提交代码所需,建议只出现下面7种类别,多了会更乱)

feat:新功能(feature)
fix:修补bug
docs:文档(documentation)
style: 格式(不影响代码运行的变动)
refactor:重构(即不是新增功能,也不是修改bug的代码变动)
test:增加测试
chore:构建过程或辅助工具的变动
scope:影响范围(可不写)
subject:对改变的正常描述,最好以动词开头语(尽量详细,必填)
body:详细描述(个人认为没必要,可不写)
footer:修改不兼容变动以及关闭 Issue时(个人认为没必要,可不写)

4.撰写合格 Commit message 的工具----Commitizen

安装:

npm install -g commitizen

在项目目录里运行

commitizen init cz-conventional-changelog --save --save-exact

END: 以后凡是用git commit命令 就换成 git cz

这样会自动提示以上几个类别

5.建议不必安装Commitizen工具,自己强制写几天就记住这七种类别了,安装校验反而积累


参考文章:
http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html

最后编辑于 :
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • git 每次提交代码都会有message说明本次commit的目的。 一. commint 介绍 命令 目前,社区...
    EdmundChen阅读 11,433评论 0赞 5
  • Git 每次提交代码,都要写 Commit message(提交说明),否则就不允许提交。 上面代码的-m参数,就...
    andyJi阅读 3,035评论 0赞 0
  • 前言 Git 每次提交代码,都要写 Commit message(提交说明),否则就不允许提交。但是,一般来说,c...
    guanguans阅读 127,084评论 1赞 63
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 137,199评论 19赞 139
  • 每一次commit是阶段性的Ending,应记录着这一阶段所完成的事以及关注点,尽可能详细具体。 注:如果可以的话...
    Jisen阅读 8,289评论 2赞 6

友情链接更多精彩内容