git commit message 建议

196 阅读1分钟
简介

通过自定义git commit-msg hooks或借助工具库可以实现commit message规范,用来约定commit message风格和提升代码可维护性。建议格式为: git commit -m "<type>: <message> [issue]",其中<message> 表示本次提交有什么内容; [issue]表示本次提交相联的 ISSUE ID(#id OR group/project#id), 它是可选的。其中<type>为以下类型:

feat        增加新功能或特性
fix         修复缺陷或问题
docs        修改文档
style       调整格式(不影响代码运行的修改,比如:调整空白符、格式化代码、增删分号等等)
refactor    重构代码(既不增加新功能,也不修复缺陷或问题的修改)
perf        提升性能,优化逻辑
test        增加或修改测试用例
chore       调整构建过程或辅助工具和依赖库
break       非兼容性变更(影响代码运行的修改,比如:删改 API ,删改 SCSS 变量等)
temp        无需记录的变更
工具库
示例
git commit -m "fix: 修复了窗口定位问题, close #123"
git commit -m "break: API getPosition() 的参数变化, 有非兼容性变更"
git commit -m "temp: 临时提交, 合并代码"