你会在Karma中找到这种惯例。
<type>(<scope>): <subject>
<body>
<footer>
它可以帮助:
- 自动生成变更日志
- 通过Git历史记录进行简单导航(例如,忽略样式更改)
Karma的约定包括:
允许的<type>
值:
- feat(用户的新功能,不是构建脚本的新功能)
- fix(用户的错误修复,不是修复构建脚本的错误)
- docs(对文档的更改)
- style(格式,缺少分号等;没有生产代码更改)
- refactor(重构生产代码,例如重命名变量)
- test(添加缺失的测试,重构测试;没有生产代码更改)
- chore(更新grunt任务等;没有生产代码更改)
示例<scope>
值:
- init
- runner
- watcher
- config
- web-server
- proxy
- 等等。
注意:git提交信息不应以空行或空行开头。
这不是非法的,但从 git 2.10(2016年第三季度)开始,默认情况下会对某些操作修剪这些行。
请查看 提交 054a5ae, 提交 88ef402, 提交 84e213a, 提交 84e213a (2016年6月29日), 提交 88ef402, 提交 84e213a (2016年6月29日), 提交 84e213a (2016年6月29日), 和 提交 4e1b06d, 提交 7735612 (2016年6月22日),作者为 Johannes Schindelin (dscho
)。
(由Junio C Hamano -- gitster
--合并于提交 62e5e83, 2016年7月11日)
reset --hard
:在报告提交主题时跳过空行
当提交消息开头有空行时,漂亮的打印机已经在显示提交主题(或完整的提交消息)时跳过它们。
自此以后,在用户调用之后报告提交主题时,我们将执行相同的操作。
git reset --hard <commit>
commit -C
: 跳过消息开头的空行
(当您使用现有的提交对象并在创建提交时重新使用日志消息和作者信息(包括时间戳)时)
与漂亮打印机制一致,我们跳过现有提交消息中的前导空行(如果有的话)。
虽然Git本身只生成具有提交头和提交消息之间单个空行的提交对象,但在提交消息开头有多个空行(即仅包含空白字符或不含字符的行)是合法的,并且漂亮打印代码已经处理了这一问题。
commit.c
:使
find_commit_subject()
更加健壮
与漂亮打印机制一样,我们应该简单地忽略提交消息开头的空行。
当早期版本的
rebase--helper
生成具有标题和提交消息之间超过一个空行的提交对象时,才注意到这种差异。