Git提交代码规范
Commit message 的格式
Git 每次提交代码,都要写 Commit message(提交说明),否则就不允许提交。
⽤commit message最好是能有规范和⼯具的约束。
每次提交,Commit message 都包括三个部分:header,body 和 footer。
其中,header 是必需的,body 和 footer 可以省略。
不管是哪⼀个部分,任何⼀⾏都不得超过72个字符(或100个字符)。这是为了避免⾃动换⾏影响美观。
<type>(<scope>): <subject>
<BLANK LINE>
<body>apex
<BLANK LINE>
<footer>
Header
Header部分只有⼀⾏,包括三个字段:type(必需)、scope(可选)和subject(必需)。
type
mistletoe歌词⽤于说明 commit 的类别,只允许使⽤下⾯7个标识。
feat:新功能(feature)
fix:修补bug
docs:⽂档(documentation)
breakevenstyle:格式(不影响代码运⾏的变动)
refactor:重构(即不是新增功能,也不是修改bug的代码变动)
guardtest:增加测试
恨的英文
chore:构建过程或辅助⼯具的变动
如果type为feat和fix,则该 commit 将肯定出现在 Change log 之中。其他情况(docs、chore、style、refactor、test)由你决定,要不要放⼊Change log,建议是不要。
scope
scope⽤于说明 commit 影响的范围,⽐如数据层、控制层、视图层等等,视项⽬不同⽽不同。
例如在Angular,可以是$location, $browr, $compile, $rootScope, ngHref, ngClick, ngView等。
npt
如果你的修改影响了不⽌⼀个scope,你可以使⽤*代替。
subject
subject是 commit ⽬的的简短描述,不超过50个字符。
其他注意事项:
以动词开头,使⽤第⼀⼈称现在时,⽐如change,⽽不是changed或changes
第⼀个字母⼩写
结尾不加句号(.)
Body
Body 部分是对本次 commit 的详细描述,可以分成多⾏。下⾯是⼀个范例。
More detailed explanatory text, if necessary. Wrap it to
about 72 characters or so.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- U a hanging indent
有两个注意点:
使⽤第⼀⼈称现在时,⽐如使⽤change⽽不是changed或changes。
永远别忘了第2⾏是空⾏
应该说明代码变动的动机,以及与以前⾏为的对⽐。
Footer
Footer 部分只⽤于以下两种情况:
不兼容变动
如果当前代码与上⼀个版本不兼容,则 Footer 部分以BREAKING CHANGE开头,后⾯是对变动的描述、以及变动理由和迁移⽅法。BREAKING CHANGE: isolate scope bindings definition has changed.
To migrate the code follow the example below:
Before:
scope: {
myAttr: 'attribute',
}
After:
shallow sleep>耆宿scope: {
myAttr: '@',
}
The removed `inject` wasn't generaly uful for directives so there should be no code using it.
关闭 Issue
directional如果当前 commit 针对某个issue,那么可以在 Footer 部分关闭这个 issue 。
Clos #234
Revert
还有⼀种特殊情况,如果当前 commit ⽤于撤销以前的 commit,则必须以revert:开头,后⾯跟着被撤销 Commit 的 Header。revert: feat(pencil): add 'graphiteWidth' option
xerox是什么This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
Body部分的格式是固定的,必须写成This reverts commit <hash>.,
其中的hash是被撤销 commit 的 SHA 标识符。
如果当前 commit 与被撤销的 commit,在同⼀个发布(relea)⾥⾯,
那么它们都不会出现在 Change log ⾥⾯。
如果两者在不同的发布,那么当前 commit,会出现在 Change log 的Reverts⼩标题下⾯。