简介
Git 提交规范是一种标准化的方式,用于编写 Git 提交信息,以确保提交历史清晰、易于理解和维护。遵循规范的提交信息可以帮助开发者更好地理解每次代码更改的目的和影响范围,从而提高代码审查、版本回退和信息查找的效率
提交类型(type)
用于说明此次提交的类型,常见的类型包括
feat
:表示新增了一个新功能modify
:修改功能fix
:修复了一个bug或问题docs
:修改了文档style
:修改了代码格式,没有改变逻辑refactor
:重构了代码,没有新增功能或修复bugperf
:优化了性能test
:添加或修改了测试用例chore
:构建过程或辅助工具的变动
作用域(scope)
表示此次提交影响的范围,可以是某个模块、组件或功能区域。
主题(subject)
是对此次提交的简短描述,通常以动词开头,使用第一人称现在时态,首字母小写,句尾不加句号。
提交文字规范
格式:提交前缀:动作行为+问题内容
示例:
- feat:新增xx页面
- feat:新增xx页面xx功能
- fix:修复xx页面xx bug
- modify:修改xx页面xx功能
- delete:删除xx页面
- refactor:重构xx页面xx功能
- style:删除多余注释代码/控制台打印代码
- refactor:迁移xx文件到xx目录
注意事项
- 提交的commit发现不符合规范,
git commit --amend -m "新的提交信息"或 git reset --hard HEAD^
重新提交一次