美文网首页
关于git提交规范

关于git提交规范

作者: 云翼飞 | 来源:发表于2019-07-17 15:39 被阅读0次

良好的Commit Message有利于代码审查,能更快速查找变更记录,并且可以直接生成Change log。

angular规范

为了规范代码提交的说明,这里我们使用angular的规范写法:

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

格式讲解

Header

Header部分只有一行,包括三个字段:type(必需)、scope(可选)和subject(必需)。

总的来说,关键就是header这部分,至于<body><footer>可省略

例如:

feat:新增财务报表

type

用于说明本次commit的类别,只允许使用下面7个标识

  • feat:新功能(feature)
  • fix:修补bug
  • docs:文档(documentation)
  • style: 格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  • test:增加测试
  • chore:构建过程或辅助工具的变动
    :::tip
    注意:如果type为feat和fix,则该 commit 将肯定出现在 Change log 之中。其他情况(docs、chore、style、refactor、test)由你决定,要不要放入 Change log,建议是不要。
    :::

scope

用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
例如:

git commit -m "feat(module:user):添加用户模块"

此提交记录中的module:user说明提交的代码影响的是user模块内容.

subject

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

以动词开头,使用第一人称现在时,比如change,而不是changed或changes
第一个字母小写
结尾不加句号(.)

使用commitizen来执行规范

  1. 全局安装commitizennode模块
npm install -g commitizen
  1. 在项目目录下运行命令
commitizen init cz-conventional-changelog --save --save-exact
  1. 运行完以上一律使用git cz 代替git commit来提交代码,同时会显示一下选项来自动生成符合格式的commit message.
    img

按照提示,你可以写出规范的message了

参考文章

相关文章

  • 我的git学习日志

    关于提交规范(git commit conventions) 参考文献: 你可能会忽略的 Git 提交规范Comm...

  • 关于git提交规范

    良好的Commit Message有利于代码审查,能更快速查找变更记录,并且可以直接生成Change log。 在...

  • iOS 小谈一叙

    一、规范 1) git 提交规范 适当使用git merge / git rebase 2) 代码规范 注意改动别...

  • Git的分支命名

    主要规范两点: git 分支命名规范 git提交记录规范 一. git 分支命名规范 git分支分为集成分支、功能...

  • gitflow 规范及工具整理

    gitflow 进阶规范 git cz 通过工具 git-cz 规范 git commit 提交信息。 使用 gi...

  • git分支命名规范

    git 分支命名规范 git 分支命名规范 为规范开发,保持代码提交记录以及 git 分支结构清晰,方便后续维护,...

  • git commit 提交规范(优化)

    git commit 提交模板和规范 Git每次提交代码,都要写 Commit message(提交说明),否则就...

  • Android Studio插件--Git Commit Tem

    规范团队代码提交,Android studio 可以使用 Git Commit Template 插件对Git提交...

  • Git 分支命名规范

    Git 分支命名规范 为规范开发,保持代码提交记录以及 git 分支结构清晰,方便后续维护,现规范 git 的相关...

  • GIT相关

    git升级版本 git update-git-for-windows git 提交规范 Header Header...

网友评论

      本文标题:关于git提交规范

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