怎样规范团队git commit ?(来自angular的commit规范)

最新推荐文章于 2024-09-20 13:50:53 发布
最新推荐文章于 2024-09-20 13:50:53 发布
阅读量664 收藏 1
点赞数 2
分类专栏： git用法 文章标签： git js
原文链接：https://www.jianshu.com/p/201bd81e7dc9
版权

前言

Git 每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。但是，一般来说，commit message 应该清晰明了，说明本次提交的目的。

不过话说回来，作为最具个人创造力和最会利用工具的物种——程序猿，最好是能有规范和工具的约束。否者的话，你可能看到以下的commit message：

目前，社区有多种 Commit message 的写法规范。本文介绍Angular 规范是目前使用最广的写法，比较合理和系统化，并且有配套的工具。前前端框架Angular.js采用的就是该规范。如下图：

Commit message 的作用

提供更多的历史信息，方便快速浏览。

比如，下面的命令显示上次发布后的变动，每个commit占据一行。你只看行首，就知道某次 commit 的目的。

$ git log <last tag> HEAD --pretty=format:%s

可以过滤某些commit（比如文档改动），便于快速查找信息

$ git log <last release> HEAD --grep feature

可以直接从commit生成Change log。

Change Log 是发布新版本时，用来说明与上一个版本差异的文档，详见后文。

其他优点

  • 可读性好，清晰，不必深入看代码即可了解当前commit的作用。

  • 为 Code Reviewing做准备

  • 方便跟踪工程历史

  • 让其他的开发者在运行 git blame 的时候想跪谢

  • 提高项目的整体质量，提高个人工程素质

Commit message 的格式

每次提交，Commit message 都包括三个部分：header，body 和 footer。

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

其中，header 是必需的，body 和 footer 可以省略。
不管是哪一个部分，任何一行都不得超过72个字符（或100个字符）。这是为了避免自动换行影响美观。

Header

Header部分只有一行，包括三个字段：type（必需）、scope（可选）和subject（必需）。

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，建议是不要。

scope

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

例如在Angular，可以是$location, $browser, $compile, $rootScope, ngHref, ngClick, ngView等。

如果你的修改影响了不止一个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
- Use 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:

    scope: {
      myAttr: '@',
    }

    The removed `inject` wasn't generaly useful for directives so there should be no code using it.

关闭 Issue

如果当前 commit 针对某个issue，那么可以在 Footer 部分关闭这个 issue 。

Closes #234

Revert

还有一种特殊情况，如果当前 commit 用于撤销以前的 commit，则必须以revert:开头，后面跟着被撤销 Commit 的 Header。

revert: feat(pencil): add 'graphiteWidth' option

This reverts commit 667ecc1654a317a13331b17617d973392f415f02.

Body部分的格式是固定的，必须写成This reverts commit &lt;hash>.，其中的hash是被撤销 commit 的 SHA 标识符。

如果当前 commit 与被撤销的 commit，在同一个发布（release）里面，那么它们都不会出现在 Change log 里面。如果两者在不同的发布，那么当前 commit，会出现在 Change log 的Reverts小标题下面。

Commitizen

可以使用典型的git工作流程或通过使用CLI向导Commitizen来添加提交消息格式。

安装

npm install -g commitizen

然后，在项目目录里，运行下面的命令，使其支持 Angular 的 Commit message 格式。

commitizen init cz-conventional-changelog --save --save-exact

以后，凡是用到git commit命令，一律改为使用git cz。这时，就会出现选项，用来生成符合格式的 Commit message。
 

validate-commit-msg

validate-commit-msg 用于检查项目的 Commit message 是否符合Angular规范。

该包提供了使用githooks来校验commit message的一些二进制文件。在这里，我推荐使用husky，只需要添加"commitmsg": "validate-commit-msg"到你的package.json中的nam scripts即可.

当然，你还可以通过定义配置文件.vcmrc来自定义校验格式。详细使用请见文档 validate-commit-msg

生成 Change log

如果你的所有 Commit 都符合 Angular 格式，那么发布新版本时， Change log 就可以用脚本自动生成。生成的文档包括以下三个部分：

  • New features

  • Bug fixes

  • Breaking changes.

每个部分都会罗列相关的 commit ，并且有指向这些 commit 的链接。当然，生成的文档允许手动修改，所以发布前，你还可以添加其他内容。

conventional-changelog 就是生成 Change log 的工具，运行下面的命令即可。

$ npm install -g conventional-changelog
$ cd my-project
$ conventional-changelog -p angular -i CHANGELOG.md -w


 

黒客与画家
关注
专栏目录
规范的 commit (Angular规范)
Novice-XiaoSong的博客
09-07 3136
1. commit message commit message 分3个部分：head, body, footer head: <type> (scop): subject type: feat, fix, docs, style, refactor, test, chore, revert, perf, build score: 影响范围 subject: 简短描述（动词开头...
【GIT】git-commit Angular规范--- 编辑中
小鱼菜鸟的博客
12-17 318
目录 1、背景 2、Angular规范 3、实例 4、某个博主采用的commit规范 5、提交模板 1、背景 目标 按照一定的规范写commit messages，可以在git push 代码之前(工具/脚本自动)检测commit messages。规范提交信息。 规范提交信息的目的： 生成 CHANGELOG.md识别不重要...
【Git】Git Commit Angular规范详解
最新发布
h1773655323的博客
09-20 917
在团队协作开发中，保持Git提交记录的一致性和清晰性对于维护项目的可读性和历史追溯至关重要。Angular团队提出了一套详细的Commit Message格式化规范，旨在解决这一问题。下面将详细介绍如何遵循Angular规范来编写Git提交信息，并探讨其带来的好处。
angular代码规范_前端知识点：git commit规范
weixin_39783360的博客
01-01 342
在日常的开发工作中，通常使用git来管理项目代码，当对代码进行修改后，可以通过git commit命令来提交代码。git 规定提交时必须要写提交信息，作为改动说明，保存在 commit 历史中，方便回溯。规范的 log 不仅有助于他人 review, 还可以有效的输出 CHANGELOG，甚至对于项目的研发质量都有很大的提升。但是在日常工作中，大多数同学对于 log 信息都是简单写写，没有很好的重...
Git commit规范（angular）
qq_34035628的博客
02-27 982
Git commit规范（angular）
vue,react,angular都在用的commit规范,了解一下?
小朱的专栏
08-19 573
截图来自vue的PR:1.commit-message规范必要性统一格式的提交记录，更清晰和易读可以通过提交记录来了解本次提交的目的，更好的CR和重构更容易了解变更，定位和发现问题每个提交描述都是经过思考的，改善提交质量直接生成ChangeLog2.规范选型常见的commit message规范有：atom，eslint和Angular等,其中Angular规范更为通用。3.Angular的Commit Message规范简介每条提交记录包含三个部分：header,body和footer<header
如何规范你的Git commit？
码农架构
04-23 785
导读：commit message应该如何写才更清晰明了？团队开发中有没有遇到过让人头疼的git commit？本文分享在git commit规范建设上的实践，规定了commit message的格式，并通过webhook在提交时进行监控，避免不规范的代码提交。 背景 Git每次提交代码都需要写commit message，否则就不允许提交。一般来说，commit message应该清晰明了，说明本次提交的目的，具体做了什么操作……但是在日常开发中，大家的commit message千奇百怪，中...
git-commit-lint-vscode:vscode一款git 规范化提交插件
05-17
git-commit-lint-vscode 在日常的开发中,目前主流的代码管理工具就是 git 了,当我们对代码进行改动了,首先得git commit提交到本地仓库,git 规定了提交时必须填写...所以git commit规范下还是很有必要的! 说明 类型 emji
Git Commit提交规范总结
拾年一剑 的专栏
02-27 6458
团队协作中，规范的Git提交记录，使提交历史明确可追溯，有助于更好的协作，方便后期代码的开发和维护
阿里内部的工程师是如何规范他们的Git commit？
weixin_47908466的博客
08-25 2143
简介：commit message应该如何写才更清晰明了？团队开发中有没有遇到过让人头疼的git commit？本文分享在git commit规范建设上的实践，规定了commit message的格式，并通过webhook在提交时进行监控，避免不规范的代码提交。 背景 因为某盘的限速功能真的是让我一个脑袋两个大，实在没办法了，就把一些资料上传到了我的git上，今天从git上扒东西的时候，家里的小朋友跟我说，你这好像一个大的网盘呀，我突然灵机一动，对啊，git用明白了真的是很厉害呀，但是g..
git commit规范化
xm2by的博客
07-27 804
git commit规范化 项目中，每次使用git提交代码时都需要填写提交信息，每个人填写提交信息的风格都不一样，为了保持项目中git commit一致性，就需要对git commit进行规范化处理，规范的git commit 可以让项目的提交信息整洁明了，也可以让我们通过提交信息可以清晰的知道本次提交的内容，出现问题时也可以更快速的查询问题，如果项目需要生成changelog日志，规范的git ...
validate-commit-message:GIT COMMIT-MSG挂钩，用于验证提交消息
05-04
验证提交消息 GIT COMMIT-MSG挂钩，用于验证提交消息。 $ validate-commit-msg创建到./lib/validate-commit-msg.js的符号链接.git/hooks/commit-msg ，该链接在每次提交时执行。 钩子脚本根据在每次提交时验证提交消息。 安装 $ npm install validate-commit-message 用法 您可以从项目的命令行激活挂钩。 $ node ./node_modules/.bin/validate-commit-msg 一种更一致的方法是在package.json添加一个脚本。 "scripts": { "init": "validate-commit-msg" } 然后执行$ npm run init 。
Angular commit 规范
qq_29744347的博客
04-12 453
顾名思义，就是范文，当前commit 所涉及的范围，通常不会很细，很细会造成有很多个scope，一般以模块或组件来划分。subject 是简短描述，body可以写更为详细的描述。用来说明本次改动造成的后果，一般都是开源项目经常用到。commit 的简短描述。
angular代码规范_基于 angular 规范的 commit
weixin_35587255的博客
01-13 918
基于 angular 规范的 commitcommit格式如下:: type - 提交 commit 的类型feat: 新功能fix: 修复问题docs: 修改文档style: 修改代码格式(不影响逻辑功能，比如格式化、补充分号等等)refactor: 重构代码(fix bug或增加新功能不属于此范围)perf: 提升页面性能test: 增加/修改测试用例chore: 修改工具相关(包括但不限于文...
Go git commit 规范指南（Angular 规范）
xmcy001122的专栏
03-09 1615
文章目录Go git commit 规范指南（Angular 规范）前言Angular规范简介有什么好处？快速知道某次 commit 的目的方便过滤可以直接从commit生成Change log其他优点Angular规范规范构成HeadertypescopesubjectBodyFooter不兼容变动关闭 IssueRevert实用工具Commitizen安装validate-commit-msg生成 Change log参考 Go git commit 规范指南（Angular 规范） 根据原文：git
git commit的一些推荐规范[AngularJS推荐]
weixin_34112181的博客
09-18 407
规范 程序员是一个千变万化但是又不离其中的职业，能够实现各种各样的功能，实现的方法也是各种各样，而最佳实践又是很多程序员比较认可和遵守的一些规则，其中会有： html-css规范：https://github.com/doyoe/html... JavaScript书写习惯：https://github.com/adamlu/jav....
angular代码规范_如何规范地提交 Git Commit Message
weixin_42499692的博客
01-01 1709
本文首发于我的个人博客：http://yifanstar.top/ Commit message 是开发的日常操作，它可以提供更多的历史信息，方便向团队清晰准确地说明代码变更、进行代码评审，也便于后期快速定位原始需求或缺陷，还可以有效的生成 Change log，对项目的管理实际至关重要，但是实际工作中却常常被大家忽略。Commit Message 格式目前，社区有多种 Commit messa...
使用 Commitizen 撰写 Angular 规范的 commit message
Metaphors' Blog
01-20 775
本文为原创文章，转载请标明出处 目录 安装及配置 使用 1. 安装及配置 npm install -g commitizen npm install -g cz-conventional-changelog commitizen init cz-conventional-changelog --save-dev --save-exact --force 2. 使用
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值