文章目录
什么是commit message
在我们使用git commit命令提交代码变更时,用于描述本次变动内容或理由的信息。对于每一次代码提交,都应该附带一个清晰、具有描述性的提交消息,以便于他人(或者未来的你自己)理解这次提交是为了解决什么问题,做了什么改变。
组成
每条 commit message 应该包含 头部, 正文 和 注脚。
其中头部的格式比较特殊,由 类型, 作用范围 和 主题 组成:
<类型>(<作用范围>): <主题>
<空行>
<正文>
<空行>
<注脚>
类型*
feat: 新功能
fix: 修复bug
perf: 性能优化方面的代码
docs: 单纯的文档内容的改动
style: 不影响代码含义或功能的修改(比如代码格式等)
refactor: 既不是 bug 修复也不是功能添加的代码,如:重构
test: 测试补全
chore: 杂项,比如代码构建流程、辅助工具等的修改
作用范围*
表明代码改动区域
主题*
代码改动会带来什么影响
正文(可选)
本次改动的动机
注脚(可选)
示例:
fix(login): 修复因为参数错误导致无法登陆