关于git代码提交描述规范可以参考:约定式提交
Commit message 的格式
Commit message 都包括三个部分:Header,Body 和 Footer。
<type>(<scope>): <subject> //header
// 空一行
<body>
// 空一行
<footer>
其中,Header 是必需的,Body 和 Footer 可以省略。
Header
type用于说明commit的类型如下
- feat:新功能(feature)
- fix:修补bug
- docs:文档(documentation)
- style:格式(不影响代码运行的变动)
- refactor:重构(即不是新增功能,也不是修改bug的代码变动)
- perf: 优化相关,比如提升性能、体验
- test:增加测试
- chore:构建过程或辅助工具的变动
- revert: 回滚到上一个版本
拓展
type在commit的是否必须存在。
- feat: 添加新特性
- fix: 修复bug
- docs: 仅仅修改了文档
- style: 仅仅修改了空格、格式缩进、逗号等等,不改变代码逻辑
- refactor: 代码重构,没有加新功能或者修复bug
- perf: 优化相关,比如提升性能、体验
- test: 增加测试用例
- chore: 改变构建流程、或者增加依赖库、工具等
- revert: 回滚到上一个版本
实际操作如下
添加了新的系统功能
git commit -m 'feat(全局):添加支付功能模块'
修改了Bug
git commit -m 'fix(header.jsx):修复页面轮播'
参考
git commit规范 github官方 阮一峰的网络日志
|