
建议使用英文描述Git Message
形式
<type>(<scope>): <subject>
(此处空一行)
写commit message
(此处空一行)
说明
type
用于说明 commit 的类别,只允许使用下面几个标识(团队约定俗成的,主要便于开发,亦可使用GitHub共识的部分)
- Add: 新增文件
- Del: 删除文件
- Mod: 修改文件
- feat:新功能(feature)
- fix:修补bug
- docs:文档(documentation)
- style: 格式(不影响代码运行的变动)
- refactor:重构(即不是新增功能,也不是修改bug的代码变动)
- test:增加测试
- chore:构建过程或辅助工具的变动
- cr: CodeReview代码评审
scope
用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同
非必须,提交时可以不用填写
subject
是commit目的的简短描述,不超过50个字符。
- 以动词开头,使用第一人称现在时,比如change,而不是changed或changes
- 第一个字母小写
- 结尾不加句号(.)
示例
新增文件
Add: add a new file
删除文件
Del: delete a new file
更新
Mod: modify a new file