安装
JetBrains 系列的 IDE 中都有能够安装此工具,我们以下 PhpStrom IDE 为例:
在 Marketplace 中搜索 Git Commit Template ,点击 Install 安装
安装完成后在 ,Commit 面板中增加了一个小按钮
点击小按钮,输入对应的内容后生成 Commit 日志内容
使用
提交类型Type
- feat 功能feature的意思,也是最常用的。当你的功能有变更的时候,都可以采用这种类型
- fix 修复Bug
- docs 更新了文档,或者更新了注释
- style 代码格式调整,比如执行了format、更改了tab显示等
- refactor 重构代码。指的是代码结构的调整,比如使用了一些设计模式重新组织了代码
- perf 性能优化
- test 单元测试
- build 调整编译参数
- ci 持续集成方面的更改。现在有些build系统喜欢把ci功能使用yml描述。如有这种更改,建议使用ci
- chore 其他改动。比如一些注释修改或者文件清理。不影响src和test代码文件的
- revert 回滚代码
除了预设外,还可以按照自己的需求,增加新的类型。
范围scope
scope 是范围的意思,主要指的是代码的影响面。无特殊必要不需要填
其他
简要说明Short description
本次提交内容主题,尽可能的一句话概括。也可以使用项目管理软件中的需求、任务、Bug的主题
正文Long description
简要说明还不能够说明白的话,在正文中补充
关键性修改Breaking changes
如果修改会影响核心逻辑,在这里说明影响及相关性修改
关闭问题Closed issues
关闭项目管理软件的的工单(例如:禅道、jira、gitlab等)
Skip CI
设置提交代码时自动触发编译,或者不编译。