美文网首页
Commit message-Angular 规范

Commit message-Angular 规范

作者: 苒妈 | 来源:发表于2016-11-01 15:01 被阅读128次

一、格式化Commit message的好处:

  • 提供历史信息,方便浏览。
  • 提取过滤commit。
  • 从commit中提取console log。

二、Commit message的格式

  • <type>(<scope>):<subject>
  • //空一行
  • <body>
  • //空一行
  • <footer>

其中Header是必需的,body和footer可以省略。


1.type

用于说明commit的类别。

feat : 新功能(feature )
fix : 修补bug
docs:文档(documentation)
style: 格式(不影响代码运行的变动)
refactor: 重构(既不新增,也不修改bug的代码变动)
test:增加测试
chore:构建过程或辅助工具的变动

2.subject

commit目的的简短描述,不超过50个字符。

  • 动词开头,比如change,而不是changed或changes
  • 第一个字母小写
  • 结尾不加句号

3.**body **

说明变动的动机,以及与以前行为的对比

4.footer

只用于两种情况。

  • 不兼容代码。以BREAKING CHANGE开头,后面是描述、变动理由和迁移方法。
    <code>
    BREAKING CHANGE: issolate scope bingings definition has changed.
    To migrate the code follow the example below:
    Before:
    scope:{
    myAttr:'attribute'
    }
    After:
    scope:{
    myAttr:'@',
    }
    The removed 'inject 'wasn't generaly useful for directives so there should be no code using it.
    </code>
  • 关闭issuse.

参考资料

相关文章

  • Commit message-Angular 规范

    一、格式化Commit message的好处: 提供历史信息,方便浏览。 提取过滤commit。 从commit中...

  • 使用 git hook 规范 Android 项目

    引言 本文所说的『规范』包含两个部分 git commit 是注释的规范 git commit 时对代码规范的检查...

  • git commit 规范

    采用 Angular 的 commit 规范。 不写 commit message 不允许提交代码,具体的规范格式...

  • Git Commit message(Angular规范)

    Git Commit message(Angular规范) Commit message 的格式 1. Heade...

  • Git commit 注释规范

    我司的 Git commit 规范,在项目的 pre-commit 钩子中校验。好像很多公司的规范都是这样,做个记...

  • git commit规范

    git commit规范 git-commit规范 在多人协作项目中,如果代码风格统一、代码提交信息的说明准确,那...

  • Git 提交规范

    前言在提交commit信息时,为了统一规范commit信息,可以在Git Hooks中编写修改commit-msg...

  • git commit 规范参考

    Angular 团队的 commit 规范 它的 message 格式如下: 分别对应 Commit messag...

  • Web前端工程化

    规范化 工程结构规范 编码格式规范 前后端接口规范 文档书写规范 Git分支管理规范 Commit描述规范 交互设...

  • git commit 规范

    使用angular + commitizen + cz-conventional-changelog 来规范git...

网友评论

      本文标题:Commit message-Angular 规范

      本文链接:https://www.haomeiwen.com/subject/yzemuttx.html