如何优雅提交 Git Commit Message

已于 2023-09-23 15:23:09 修改
阅读量478 收藏
点赞数
文章标签： git git commit message
于 2023-05-23 23:32:03 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_63748493/article/details/130837656
版权
文章介绍了如何按照Angular团队的规范编写Gitcommitmessage，包括类型（feat,fix等）、主题、正文和脚注。推荐使用commitizen工具来规范化提交信息，并可通过cz-customizable自定义适配器。此外，文章还提到了commitlint用于校验message，以及husky用于设置Git钩子，确保commit消息遵循预设规范。
摘要由CSDN通过智能技术生成

Message 规范

那么如何能优雅而又不失体面的提交你的代码呢？其实我们的 git commit message 是应该具备一些规范的。目前规范用的比较多的是 Angular 团队的规范

message 样例：

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

  • Type

    ：必须是下列之一

    • feat：一个新功能
    • fix：bug修复
    • docs：编辑文档
    • style：不影响代码含义的更改(空格、格式、缺少分号等，不是css的更改)
    • refactor：既不修复bug也不添加特性的代码更改
    • perf：提高性能的代码更改
    • test：添加缺失的或纠正现有的测试
    • chore：对构建过程或辅助工具和库(如文档生成)的更改

  • Subject：主题包含对变更的简洁描述

  • Body：具体的修改内容，可以包括与之前的对比

  • Footer：通常是 BREAKING CHANGE 或修复的 issue 链接

规范工具

简介

commitizen git commit 格式化工具, 为我们提供标准化的 commit 信息。 帮助我们统一项目commit ， 便于信息的回溯或日志的生成。# commit message 格式

commitizen 只是提供一个commit 格式化或交互工具, 最终需要输出符合 commit 规则的信息给 git， 所以需要线了解 commit 格式规则

安装

npm install -D commitizen cz-conventional-changelog

package.json中添加

  "scripts": {
  	...
    "commit": "git-cz"
  },
  "config": {
    "commitizen": {
      "path": "./node_modules/cz-conventional-changelog"
    }
  }

自定义 Adapter

如果 Angular 的规范不符合我们的实际，同样我们也可以通过 cz-customizable 定制一套符合自己或者团队的规范。

npm install -D cz-customizable

同时package.json需要修改

"config": {
  "commitizen": {
    "path": "node_modules/cz-customizable"
  }
}

之后对应项目目录下创建 .cz-config.js 文件，用来维护自己的格式

官网中有对应的样例配置文件：cz-customizable/cz-config-EXAMPLE.js at master · leoforfree/cz-customizable · GitHub

校验 Message

工具：

可以做到如果不符合校验规范，就会直接拒绝 commit 请求

安装
# Angular 团队的规范
npm install -D @commitlint/config-conventional @commitlint/cli
# 自定义规范
npm install -D commitlint-config-cz @commitlint/cli
配置文件

在项目目录下创建配置文件 .commitlintrc.js

Angular 团队的规范

module.exports = {
  extends: [
    ''@commitlint/config-conventional''
  ],
  rules: {
  }
};
自定义规范
module.exports = {
  extends: [
    'cz'
  ],
  rules: {
  }
};

Husky

在做前端工程化时husky可以说是一个必不可少的工具。husky可以让我们向项目中方便添加git hooks。

官方链接：typicode/husky: Git hooks made easy 🐶 woof! (github.com)

安装
npm install -D husky
配置

package.json中添加：

"husky": {
    "hooks": {
      ...,
      "commit-msg": "commitlint -e $GIT_PARAMS"
    }
  },

或者在 .huskyrc 文件中

{
  "hooks": {
    ...,
    "commit-msg": "commitlint -e $GIT_PARAMS"
  }
}
白木Channel
关注
专栏目录
git commit message编写指南
jeezx
12-21 2272
0. Commit message编写指南 【声明】参考angular代码规范及部分博客整理，仅学习记录，非商用。 1. 概述 日常开发中使用 git 提交代码要求一定要写 git commit message，否则就无提交代码。 commit message作为改动说明，保存在 commit 历史中，方便回溯。 规范的 log 不仅有助于他人 review, 还可以有效的输出 CHANGELOG，甚至对于项目的研发质量都有很大的提升。 规范git commit到底有哪些好处呢？ 便于程序员对提交历史进
【知识整理】Git Commit Message 规范_commit message rule violation
2401_84167086的博客
05-06 908
每次提交，Commit Message 都包括三个部分：Header，Body 和 Footer。Commit Message 提示说明示例。
git commit 提交信息规范入门(配合vscode)
川端小树的博客
10-02 1万+
1.前言 在git commit中提交信息中，如果能找按照规范写好，能提高可读性以及项目维护效率。本文针对message的规范和提交检测工具进行介绍。 2.参考的规范：Angular Team Commit Specification 详细的提交信息可以让人知道本次提交对原项目进行哪方面的修改。是修复bug、添加组件或模块、修改代码风格还是重构。从message中也可以知道针对哪部分的文档或模块进行修改。 但这个message到底要怎么去写比较好？这里可以参考Angular团队的git-commit
项目配置：commitizen工具使用
M31Gargantua的博客
02-06 472
提交代码前规范git commit的风格来进行提交，这样可以快速定位每次提交的内容，方便之后对版本进行控制。
2024年大数据最新【知识整理】Git Commit Message 规范_git commit msg 规则(2)，2024年最新熬夜整理小米大数据开发面试题
2401_84573307的博客
05-05 303
fix(common): 修复字体过小的BUG，将通用管理下所有页面的默认字体大小修改为 14pxfeat(*): 添加网站主页静态页面这是一个示例，假设对点检任务静态页面进行了一些描述。这里是备注，可以是放BUG链接或者一些重要性的东西。
Git commit-msg 提交模板配置
最新发布
人生只是一种体验，不必用来演绎完美。
05-15 455
/添加指定配置文件，将该内容作为初始化信息填写到提交信息中。执行完命令，多了以下内容。
git 配置commit-msg
总结，交流，记录，成长
09-01 1458
有些时候公司会要求git commit 强制附加jira链接，确定本次提交属于某个具体任务，提供下解决思路。调研后决定使用husky和commitlint实现。
leetcode2-git-commit-message-helper:一个帮助git代码提交规范的JetBrains系列插件，支持IDEA、
06-29
git-commit-message-helper 本插件是源idea插件的升级版，增加了一系列个性化配置。 安装 直接从 IDE 插件管理器安装（文件 > 设置 > 插件 > 浏览器存储库 > Git Commit Message Helper） 用法 如果要更改提交类型，...
idea git commit插件
03-24
idea commit 模板插件
这个插件让你不再苦恼如何写 Git Commit Message
cxyITgc的博客
02-28 1795
这个插件让你不再苦恼如何写 Git Commit Message
git配置commit检验
lhc66666的博客
04-27 1577
1、如果只需要配置单独项目git hooks，可按如下配置： 在.git/hooks目录下有很多钩子，我们可以根据需要自定义不同的内容，这里我们只需要修改commit-msg即可。 首先将commit-msg.sample 改为 commit-msg，也就是去掉后缀，然后配置commit-msg。 当我们提交不规范的commit信息时就会提醒用户，并终止此提交 2、如果需要配置全局git hooks，可按如下配置： 全局hook 1.在用户根目录下创建git_template目录 mkdir -p
安装npm, Commitizen, 与Git commit message
mainking2003的博客
07-13 1187
吐槽 本来是为了规范git commit的编写，研究了一下Commit message。大多数博文推荐使用Commitizen，而其安装需要借助npm。 在Ubuntu16.04下，依照各贴文的讲解，先装npm再装Commitizen踩了一堆的坑，包括但不限于： SyntaxError: Block-scoped declarations (let, const, function, class) not yet supported outside strict mode (版本问题) Error: E
优雅的提交你的 Git Commit Message
weixin_34148456的博客
05-16 242
题注：如果喜欢我们的文章别忘了点击关注阿里南京技术专刊呦~ 本文转载自 阿里南京技术专刊-知乎，欢迎大牛小牛投递阿里南京前端/后端开发等职位，详见 阿里南京诚邀前端小伙伴加入~。 commit message 是开发的日常操作, 写好 log 不仅有助于他人 review, 还可以有效的输出 CHANGELOG, 对项目的管理实际至关重要, 但是实际工作中却常常被大家忽略. 希望通过本文, 能够...
配置手动提交_如何配置 Git Commit Message
weixin_39559369的博客
12-30 897
一、背景好的 commit message，能够在多人协作的大型项目中，快速定位代码提交历史，回溯问题根源，提高团队效率。commit message 是提交代码过程中的log，属于项目管理中一个重要的环节。我们以前端 React 生态体系为例：【路由】：react-router / react-router-redux等。 【状态管理】：flux 、redux、mobx等。 【UI库】：mat...
git commit 模板配置
leibosite的博客
09-15 1万+
Git Log 之痛在《The Art of Readable Code》这本经典书中，有个形象的比喻，衡量代码可读性的指标是阅读代码时每分钟的 WTF 次数，而在读 Git 提交历史的时候，不知道你有多少次爆粗口？不相信？你现在打开公司演进最快的项目，执行 git log，信息量过少甚至是误导的 commit message 非常常见，比如：fix =&gt; 这到底是 fix 什么？为...
如何规范提交你的git commit message
weixin_42662358的博客
06-21 5489
今天被大佬说让我学习下git commit 的格式规范，学习工作的规范是宜早不宜迟啊！不然还是要重新返工，因为跑代码不在本机上，刚开始用git的时候经常来回push。git commit的信息每一次提交就要写，写的多了后来就有点随意了。现在回头看简直惨不忍睹，有用的信息太少无法判断修改的内容在哪里。 今天特此来记录学习，如有错误还望多提意见！ 盗用知乎上的一句话：“这种东西，当然要借助工具了，才...
git commit msg格式规范校验
跟派大星学编程
04-12 1万+
commit规范 每个公司的规范都是不同的，这里讲下我常用的规范 type(模块): message type 用于说明 commit的类别，只允许使用下面7个标识。 feat：新功能（feature） fix：修补bug test：增加测试 docs：文档（documentation） style： 格式（不影响代码运行的变动） refactor：重构（即不是新增功能，也不是修改bug的代码变...
Gerrit的commit-msg hook使用指南
热门推荐
成长的足迹
04-23 3万+
Git hooks是Git提供的一种机制，这些hooks能够直接被git commit命令调用，无需开发人员手工设置。Gerrit提供的commit-msg hook，被调用时，可以自动根据模板编辑commit message，开发人员不必再手工输入commit message。1.commit-msg hook实现机制在Gerrit中，该hook实际上就是一个简短的Shell脚本实现。commi...
git commit message helper
09-01
git commit message helper是一个辅助工具，用于帮助我们编写更好的git提交信息。 在进行版本控制时，我们通常会使用git进行代码管理，并且会通过提交(commit)来记录每次的修改。一个好的提交信息可以让其他人更容易理解我们做了哪些修改以及修改的原因。 git commit message helper可以提供以下功能： 1. 提供格式规范：git commit message helper可以为我们提供一份提交信息的格式规范。这样，在编写提交信息时，我们可以按照这个规范来进行，以遵循一致的风格。 2. 提示关键信息：git commit message helper可以通过自动补全或显示相关选项来提示我们填写关键信息。比如，当我们输入某个关键词时，它可以自动给出一些常见的选项供我们选择，以避免遗漏重要信息或填写错误。 3. 语法检查：git commit message helper可以帮助我们进行提交信息的语法检查。它可以检查是否符合规范，是否存在拼写错误等，从而提供更准确的提交信息。 4. 快捷操作：git commit message helper可以提供一些快捷操作，以便更方便地编写提交信息。比如，可以设置快捷键或命令来快速填写某些常用的信息，如修改的模块、bug修复等。 总而言之，git commit message helper是一个实用工具，可以帮助我们编写更好、更准确的提交信息。它不仅可以提高版本控制的效率，还有助于团队合作和代码维护的规范性。使用这个工具可以在一定程度上提高代码开发和管理的效果。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

白木Channel

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值