如何提交规范的 git commit message

时间 2019-12-18

标签如何提交规范 git commit message 栏目 Git 繁體版

原文原文链接

规范化 commit message 的做用

提供更多的历史信息
能够筛选提交内容
能够直接从commit生成Change log

下面展现一下小编的 commit messagenode

这是生成的 CHANGELOGgit

如今开始介绍如何去编写规范的 commit message

git commit message 格式

目前规范使用较多的是 Angular 团队的规范, 继而衍生了 Conventional Commits specification. 不少工具也是基于此规范, 它的 message 格式以下:github

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
复制代码

每一个提交消息由header，body和footer组成，其中 body 和 footer 能够省略express

Header

header只有一行，包括三个字段：type（必需）、scope（可选）和subject（必需）json

type 用于说明 commit 的类别

feat 一项新功能
fix 错误修复
docs 文档
style 不影响代码含义的更改（空格，格式，缺乏分号等）
refactor 代码更改既不修复错误也不添加功能
perf：改进性能的代码更改
test 添加缺失或更正现有测试
chore 对构建过程或辅助工具和库（如文档生成）的更改

scope 范围

范围能够是指定提交更改位置的任何内容，能够*在更改影响多个范围时使用bash

subject 主题

这次commit的简洁描述，不超过50个字符, 推荐使用英语提交commit。app

使用命令式，使用"change" 不是 "changed" 也不是 "changes"
不要把第一个字母大写
最后没有点 .

body 主体

body 部分是对本次 commit 的详细描述，能够分红多行，好比描述与提交以前有什么不一样。ide

footer 页脚

兼容性

全部重大更改都必须做为页脚中的更改块说起，它应以“BREAKING CHANGE”一词开头：空一到两行。而后，提交消息的其他部分是对更改，理由和迁移说明的描述。工具

BREAKING CHANGE: isolate scope bindings definition has changed and
    the inject option for the directive controller injection was removed.
    
    To migrate the code follow the example below:
    
    Before:
    
    scope: {
      myAttr: 'attribute',
      myBind: 'bind',
      myExpression: 'expression',
      myEval: 'evaluate',
      myAccessor: 'accessor'
    }
    
    After:
    
    scope: {
      myAttr: '@',
      myBind: '@',
      myExpression: '&',
      // myEval - usually not useful, but in cases where the expression is assignable, you can use '='
      myAccessor: '=' // in directive's template change myAccessor() to myAccessor } The removed `inject` wasn't generaly useful for directives so there should be no code using it.

复制代码

issue

关闭 issus 应该在页脚的单独行中列出，前缀为“Closes”关键字，以下所示：性能

Closes #234
// 多个
Closes #123, #245, #992
复制代码

更多内容参考

举个栗子

这是我本身项目提交时使用的message, 你们能够参考，下面是手动敲的，可使用工具 commitizen/cz-cli, 自动生成标准的commit message, 在此很少介绍

feat: write log message into file

Put log message into appoint dir, it will create the dir if not exist

复制代码

refactor(package.json): update nodejs version and license

The version was 1.0.0, the license was ISC before update, and now, the version is 0.0.1, license is MIT

复制代码

更多栗子