Git Commit Message规范
格式
1 | <type>(<scope>): <subject> |
提交信息包含三个部分header(type、scope、subject)、body和footer,用空行分隔。每个部分不能超过100个字符。
header: 必填,且必须符合header格式。
body: 可填,详细描述提交的内容,可以分为多行。
footer: 可填,其他备注, 一般用于不兼容更新或关闭issue。
header
header包括三个部分:type(必填)、scope(可填)和subject(必填)。
type
type: commit 类型,有业内常用的字段,也可以根据需要自己定义。
类型 | 描述 |
---|---|
feat | 增加新功能 |
fix | 修复问题/BUG |
docs | 文档/注释 |
style | 代码风格相关无影响运行结果的 |
refactor | 重构 |
test | 测试相关 |
chore | 构建过程或辅助工具的变动 |
scope
scope: commit影响的范围, 比如某某组件、某某页面。
subject
subject: 简短描述提交的内容。