软件开发日益规范,Git的message也必须要规范起来!
在企业开发当中,开发的模式更多的团队协作,而并非一个coding。但是每个人的代码风格可能都不一样,更何况是Git的commit信息呢,各种千奇百怪,也并不是全部否认所有人,但是项目规范在企业开发是非常重要的,这时候Git的commit的信息也是需要符合规范,这样大家都知道你提交的代码都干了些什么。
Commit message 的格式
每次提交,Commit message 都包括三个部分:Header,Body 和 Footer。
<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
feat:新功能(feature) fix:修补bug docs:文档(documentation) style: 格式(不影响代码运行的变动) refactor:重构(即不是新增功能,也不是修改bug的代码变动) test:增加测试 chore:构建过程或辅助工具的变动
如果type为feat
和fix
,则该 commit 将肯定出现在 Change log 之中。其他情况(docs
、chore
、style
、refactor
、test
)看实际情况决定,要不要放入 Change log,建议是不要。
scope
scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
subject
subject是 commit 目的的简短描述,不超过50个字符。
以动词开头,使用第一人称现在时,比如change,而不是changed或changes 第一个字母小写 结尾不加句号(.)
Body
Body 部分是对本次 commit 的详细描述,可以分成多行
Footer
Footer 部分只用于两种情况。 (1)不兼容变动 如果当前代码与上一个版本不兼容,则 Footer 部分以BREAKING CHANGE开头,后面是对变动的描述、以及变动理由和迁移方法。 (2)关闭 Issue 如果当前 commit 针对某个issue,那么可以在 Footer 部分关闭这个 issue 。
还有一种特殊情况,如果当前 commit 用于撤销以前的 commit,则必须以revert:开头,后面跟着被撤销 Commit 的 Header。
不管是作为后端或者还是前端的开发人员,大多数都会使用Git提交代码,强大的Idea有很多插件可以安装,当然Git的Commit的Message也是一样,在Plugins里面搜索 Git Commit Template 。
提交代码的时候