git-commitAngular规范

更新时间:2023-05-12 20:58:56 阅读: 评论:0

git-commitAngular规范
commit message的格式
每次提交,Commit message 都包括三个部分:Header,Body 和 Footer。
<type>(<scope>): <subject>
// 空⼀⾏
<body>
// 空⼀⾏
<footer>
亮度其中,Header 是必需的,Body 和 Footer 可以省略。
不管是哪⼀个部分,任何⼀⾏都不得超过72个字符(或100个字符)。这是为了避免⾃动换⾏影响美观。
Header
龙生九子Header部分只有⼀⾏,包括三个字段:type(必需)、scope(可选)和subject(必需)。
(1)type
type⽤于说明 commit 的类别,只允许使⽤下⾯7个标识。
feat:新功能(feature)
fix:修补bug
docs:⽂档(documentation)
style:格式(不影响代码运⾏的变动)
refactor:重构(即不是新增功能,也不是修改bug的代码变动)
test:增加测试
chore:构建过程或辅助⼯具的变动
如果type为feat和fix,则该 commit 将肯定出现在 Change log 之中。其他情况(docs、chore、style、refactor、test)由你决定,要不要放⼊Change log,建议是不要。
(2)scope
scope⽤于说明 commit 影响的范围,⽐如数据层、控制层、视图层等等,视项⽬不同⽽不同。
(3)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
有两个注意点。
(1)使⽤第⼀⼈称现在时,⽐如使⽤change⽽不是changed或changes。
(2)应该说明代码变动的动机,以及与以前⾏为的对⽐。
Footer
妙趣横生的意思是什么Footer 部分只⽤于两种情况。
(1)不兼容变动
如果当前代码与上⼀个版本不兼容,则 Footer 部分以BREAKING CHANGE开头,后⾯是对变动的描述、以及变动理由和迁移⽅法。BREAKING CHANGE: isolate scope bindings definition has changed.
To migrate the code follow the example below:
Before:
scope: {
myAttr: 'attribute',
}
After:
scope: {
myAttr: '@',
}
The removed `inject` wasn't generaly uful for directives so there should be no code using it.
(2)关闭 Issue
照相机成像原理如果当前 commit 针对某个issue,那么可以在 Footer 部分关闭这个 issue 。
Clos #234
也可以⼀次关闭多个 issue 。
Clos #123, #245, #992
Revert
还有⼀种特殊情况,如果当前 commit ⽤于撤销以前的 commit,则必须以revert:开头,后⾯跟着被撤销 Commit 的 Header。
revert: feat(pencil): add 'graphiteWidth' option
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
Body部分的格式是固定的,必须写成This reverts commit <hash>.,其中的hash是被撤销 commit 的 SHA 标识符。
安监站如果当前 commit 与被撤销的 commit,在同⼀个发布(relea)⾥⾯,那么它们都不会出现在 Chan
ge log ⾥⾯。如果两者在不同的发布,那么当前 commit,会出现在 Change log 的Reverts⼩标题下⾯。

本文发布于:2023-05-12 20:58:56,感谢您对本站的认可!

本文链接:https://www.wtabcd.cn/fanwen/fan/82/604359.html

版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系,我们将在24小时内删除。

标签:变动   代码   影响
相关文章
留言与评论(共有 0 条评论)
   
验证码:
推荐文章
排行榜
Copyright ©2019-2022 Comsenz Inc.Powered by © 专利检索| 网站地图