Commit Message 规范

最新推荐文章于 2024-04-12 05:47:06 发布
最新推荐文章于 2024-04-12 05:47:06 发布
阅读量196 收藏
点赞数
文章标签： git javascript 测试 ViewUI
原文链接：https://segmentfault.com/a/1190000016893334
版权
统一团队 Git commit 日志标准，便于后续代码 review ，版本发布以及日志自动化生成等等。
统一团队的Git工作流，包括分支使用、tag 规范、issue 等。

Git commit日志基本规范

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

对格式的说明如下：

type代表某次提交的类型，比如是修复一个bug还是增加一个新的feature。所有的type类型如下：

  • feat： 新增feature
  • fix: 修复bug
  • docs: 仅仅修改了文档，比如README, CHANGELOG, CONTRIBUTE等等
  • style: 仅仅修改了空格、格式缩进、都好等等，不改变代码逻辑
  • refactor: 代码重构，没有加新功能或者修复bug
  • perf: 优化相关，比如提升性能、体验
  • test: 测试用例，包括单元测试、集成测试等
  • chore: 改变构建流程、或者增加依赖库、工具等
  • revert: 回滚到上一个版本
格式要求：
# 标题行：50个字符以内，描述主要变更内容

# 主体内容：更详细的说明文本，建议72个字符以内。 需要描述的信息包括:

# * 为什么这个变更是必须的? 它可能是用来修复一个bug，增加一个feature，提升性能、可靠性、稳定性等等

# * 他如何解决这个问题? 具体描述解决问题的步骤

# * 是否存在副作用、风险? 

# 尾部：如果需要的化可以添加一个链接到issue地址或者其它文档，或者关闭某个issue。
Commit messages书写建议
  • 尽可能多的提交，单个Commit messages包含的内容不要过多；
  • 标题行以Fix, Add, Change, Delete开始，采用命令式的模式。不要使用Fixed, Added, Changed等等；
  • 始终让第二行是空白，不写任何内容；
  • 主体内容注意换行，避免在gitk里面滚动条水平滑动；
  • 永远不在 git commit 上增加 -m 或 --message= 参数，提交的时候git commit即可；
  • 如果你是vim用户，将下面这行代码加入到~/.vimrc。这会帮助你检查拼写和自动换行。 autocmd Filetype gitcommit setlocal spell textwidth=72
使用Commitizen工具

Commitizen可以让你的commit message更加规范统一，适合项目团队使用，使用也很简单，使用npm安装后，提交代码的时候使用git cz去替代以前的git commit命令即可。
安装commitizen：

npm install -g commitizen

使用截图：

clipboard.png

自动生成Change log

conventional-changelog是用来从git的元数据中生成 Change log文档的工具，只要你提交的格式满足它定义的标准，此处以angular标准为例子。使用它生成的Change log包含以下三个部分：

  • Bug Fixes Bug修复的信息
  • Features 增加的特性
  • BREAKING CHANGES 重大变更

可以参考它生成的文档CHANGELOG.md，使用如下：

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

Git分支与版本发布规范

基本原则：master为保护分支，不直接在master上进行代码修改和提交。

  • 开发日常需求或者项目时，从master分支上checkout一个feature分支进行开发或者bugfix分支进行bug修复，功能测试完毕并且项目发布上线后，将feature分支合并到主干master，并且打Tag发布，最后删除开发分支。分支命名规范：

  • 分支版本命名规则：分支类型 分支发布时间 分支功能。比如：feature_20170401_fairy_flower

    • 分支类型包括：feature、 bugfix、refactor三种类型，即新功能开发、bug修复和代码重构
    • 时间使用年月日进行命名，不足2位补0
    • 分支功能命名使用snake case命名法，即下划线命名。

  • Tag包括3位版本，前缀使用v。比如v1.2.31。Tag命名规范：

    • 新功能开发使用第2位版本号，bug修复使用第3位版本号

    • 核心基础库或者Node中间价可以在大版本发布请使用灰度版本号，在版本后面加上后缀，用中划线分隔。alpha或者belta后面加上次数，即第几次alpha：

      • v2.0.0-alpha-1
      • v2.0.0-belta-1

版本正式发布前需要生成changelog文档，然后再发布上线。

参考资料

Commit message 和 Change log 编写指南 阮一峰
如何写好 Git commit messages 腾讯IVWEB团队
如何写好 Git commit log? 知乎
优雅的提交你的 Git Commit Message 阿里
你可能会忽略的 Git 提交规范 掘金

weixin_34150830
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Commit-Message-Plugin:提交信息模板规范化插件
05-19
Commit-Message-Plugin提交信息模板规范化插件一、代码提交规范化的目的为了部门提交代码信息格式规范化为了更好的追溯代码、筛选为了更加快速的定位提交代码所涉及的范围和实现功能为了后续代码的Review、自动生成...
vscode-commit-message-editor:以方便的方式编辑提交消息
03-09
提交消息编辑器 以方便的方式编辑提交消息。 特征 从最近的提交中选择一个较早的提交消息 编辑表单中的提交消息 可定制的常规提交消息模板 可自定义的表单字段 修改最后的提交信息 ... commit-message-e
Commit Message规范
weixin_42384238的博客
04-02 204
格式：<type>: <subject> 举例： feat: 这是一个新功能 fix: 这是一个bug 用于说明本次commit的类别，只允许使用下面7个标识 feat：新功能（feature） fix：修补bug docs：文档（documentation） style： 格式（不影响代码运行的变动） refactor：重构...
Commit message 写法规范
cab5的博客
11-18 825
一、概述 对于日志的提交一直都没有形成一个很好的规范（每次提交都比较随意：<），最近看到一篇文章，里边有一章节介绍了一种写法规范（感觉还不错:>），从该文得知当前业界比较广泛应用的是 Angular Git Commit Guidelines https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines 二、具体格式 <type>: <subject> &l
Commit message规范参考
siwen0的博客
06-05 230
参考文章： http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html
Git commit message规范
lingyang999的博客
08-16 6226
参考文档：https://mp.weixin.qq.com/s/mAUqTPCqcYjoNDqAxktyfA 使用工具简介：commitizen、cz-conventional-changelog、commitlint、husky commitizen：Commitizen是一款提升GIT提交过程效率的小工具。它会提示你提供任何必要字段，还会恰当地格式化提交信息。Commitizen内置了对多种提交规范的支持，同时还允许你定制自己的提交规则。这个简单的工具能够节约时间，而不必等待提交钩子运行检查再驳回提
leetcode2-git-commit-message-helper:一个帮助git代码提交规范的JetBrains系列插件，支持IDEA、
06-29
git-commit-message-helper 本插件是源idea插件的升级版，增加了一系列个性化配置。 安装 直接从 IDE 插件管理器安装（文件 > 设置 > 插件 > 浏览器存储库 > Git Commit Message Helper） 用法 如果要更改提交类型，...
commit-message-checker:GitHub Action根据正则表达式模式检查推送和拉取请求的提交消息
05-02
GS提交消息检查器 一个GitHub操作，用于检查提交消息是否与正则表达式模式匹配。 该动作能够对请求请求和请求事件进行操作，并检查请求请求的...name : ' Commit Message Check ' on : pull_request : types : - o
How to Write a Git Commit Message
04-25
- 利用诸如`git commit --amend`或提交钩子等工具帮助优化提交过程。 通过遵循上述规则和技巧，你可以显著提高自己的提交消息质量，从而更好地与团队成员沟通并维护项目的历史记录。优秀的提交消息不仅能够提升...
Git —— Commit Message 规范介绍
Ccccxc的博客
12-26 2242
日常开发中，我们经常会使用到 Git 进行代码管理，而 Git 中最常用的命令就是git commit，我们通过 commit 命令将修改后的代码提交到本地仓库，然后再通过git push命令将本地仓库的代码推送到远程仓库。git 规定提交时必须要写提交信息，作为改动说明，保存在 commit 历史中，方便回溯。规范的 log 不仅有助于他人 review, 还可以有效的输出 CHANGELOG，甚至对于项目的研发质量都有很大的提升，尤其是一些长期持续迭代维护，且多版本长期并存的项目。
Git Commit 之道：规范化 Commit Message 写作指南
热门推荐
pursuit的博客
11-12 1万+
在软件开发的征程中，清晰明了的 Git Commit Messages 是项目成功的关键。本指南将教你如何通过规范化 Git 提交信息，提高代码可读性，以及如何巧妙撰写自动生成的 Change Logs，精准记录项目的演变。让你的团队与你共同领略 Git Commit 的精髓，推动项目可维护性的巅峰。
Git Commit Message规范
老男孩的架构路
09-09 1559
不知道大家在各自项目中是如何写提供代码的commit message, 我们项目有的同事写的很简单，压根不知道提交了什么内容，是新功能还是缺陷修复。本质上 commit message就是为了让团队成员知道这次提交的内容，为此，我们出了一个规范，约定团队的每个同事按照这个规范提交代码，达到通过message能够了解此次修改的内容。
【知识整理】Git Commit Message 规范_git commit msg 规则
最新发布
2401_84183492的博客
04-12 1544
外链图片转存中…(img-VKZ2Dmto-1712871950994)]
如何写好 Git commit messages
banyan3646的博客
02-21 463
导语：任何软件项目都是一个协作项目，它至少需要2个开发人员参与，当原始的开发人员将项目开发几个星期或者几个月之后，项目步入正规。不过他们或者后续的开发人员仍然需要经常提交一些代码去修复bug或者实现新的feature。我们经常有这种感受：当一个项目时间过了很久之后，我们对于项目里面的文件和函数功能渐渐淡忘，重新去阅读熟悉这部分代码是很浪费时间并且恼人的一件事。但是这也没法完全避免，我们...
规范Git Commit Message
wsl的专栏
11-07 582
让Commitlint支持Angular规范 一、安装依赖： 1、自动检测依赖安装 npm install --save-dev @commitlint/config-angular @commitlint/cli 或者用yarn yarn add @commitlint/config-angular @commitlint/cli -D 2、配置 husky (pre-commit)...
Git Commit message 编写规范
yanglingchao的博客
04-21 1011
在 Git 中，每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。这个操作将通过 git commit 完成。上面代码的-m参数，就是用来指定 commit mesage 的。如果一行不够，可以只执行git commit，就会跳出文本编译器，让你写多行。git commit在我们开发中，直接在idea中装插件使用，其中必填为type和short description；
【知识整理】Git Commit Message 规范
李木
02-23 2514
前面咱们整理过Code Review 一文，提到了 Review 的重要性，已经同过gitlab进行CodeReview 的方式，那么本文详细说明一下对CodeReivew非常重要的Git Commit Message 规范。我们在每次提交代码时，都需要编写 Commit Message，否则是不允许提交的。书写好的 Commit Message 能大大提高代码维护的效率。避免开发人员在项目中群魔乱舞，搞得代码一团糟，搞的项目就被糟践了。且开发日后的维护，都将是灾难。
Git commit message的规范
qq_41995398的博客
08-20 498
本文参考了知乎 ”阿里技术“账号内容 背景: 用Git的小伙伴可能会遇到这种问题，即经过多次commit之后出现问题，经排查很有可能是因为之前的某次commit时，做了不恰当的调整。这时候如果在之前的commit之中，没有规范自己的commit message，那么排查起来将会非常痛苦。所以规范自己的commit message 信息变得尤为重要。 commit message格式 <type>(<scope>): <subject> type(必须) 用于说
git commit message 规范
06-06
### 回答1： Git commit message规范是指Git版本控制系统中提交代码时，对于commit message的书写规范化。这样可以让每个commit message都更加清晰明确，便于开发者和其他项目成员理解和维护代码。常见的规范包括commit message的格式、内容、长度、语言等方面。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值