Git Commit 规范参考

最新推荐文章于 2024-07-18 08:48:23 发布
最新推荐文章于 2024-07-18 08:48:23 发布
阅读量964 收藏 4
点赞数
分类专栏： 规范参考 文章标签： git
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u011194386/article/details/105414947
版权
本文介绍了遵循Angular规范的Git Commit格式，包括Type、Scope、Subject等部分，强调了规范提交的好处，如清晰历史信息和自动化Changelog。同时，讨论了commitizen、commitlint和standard-version等工具的使用，帮助开发者实现更规范的Git提交。
摘要由CSDN通过智能技术生成

引子

在 github 上逛逛就可以发现，其提交的 commit 都有一定格式，工作中也有相应的规定，时间长了就能体会到其中的好处。这种约束是一种良好的实践。抽出一些时间，更详细的了解相关的资料，然后做了一些实践和总结。

规范 Commit 的好处

  1. 提供更明确的历史信息，方便判断提交目的和浏览
  2. 可以过滤某些不必要的提交，方便快速查找信息
  3. 自动化生成 Changelog
  4. 向同事、公众与其他利益关系人传达变化的性质
  5. 基于提交的类型，自动决定语义化的版本变更

以上的好处，个人认为要有一个大的前提，就是每一个提交，尽量保证其目的单一性，比如说几个 bug 看似类似，就一次性修改提交。这样做，让 commit 的信息变的复杂化，阅读不方便，也容易让人想到一些不必要的关联性。

Commit 的格式

找了几个 start 较多的库，看看提交的格式。

  1. react-commit

7-react-commit

  1. vuejs-commit

7-vuejs-commit

  1. angular-commit

7-angular-commit

网上推荐的写法是第 2 和 3 种，也就是 Angular 规范，并有配套的工具。有一个文档对 commit 的格式要求有个描述叫约定式提交。下面就根据 Angular 规范和对应文档，看看详细的说明。

每个 commit message 包含一个 header，body 和 footer。header 有一个特殊的格式包含有 type，scope 和 subject：

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

header、body、footer 之间都要空一行，header

最低0.47元/天 解锁文章
_XXHolic_
关注
专栏目录
git代码提交规范
relo的博客
04-08 419
build 编译相关的修改，例如发布版本、对项目构建或者依赖的改动 chore 其他修改, 比如改变构建流程、或者增加依赖库、工具等 ci 持续集成修改 docs 文档修改 feat 新特性、新功能 fix 修改bug perf ...
Git Commit 规范
DTCloud
06-13 953
遵循 Git Commit 规范可以提高团队协作效率和代码库的可维护性。通过明确的 Commit 类型和格式，开发者能够更轻松地理解每个提交所带来的更改，并能够快速回溯和回滚代码。建议团队在项目中制定统一的 Git Commit 规范，并通过培训和代码审查来确保规范的遵循。这将有助于提升代码质量、减少问题和改进团队的协作流程。Git文档作者：郑集文。
前端代码规范- Commit 提交规范
最新发布
油墨香^-^的博客
07-18 66
├── public├── src└── .cz-config.js // 创建复制代码是一个可以在 Git hooks 中使用的 npm 包，它可以帮助你在特定的 Git 事件发生时执行命令，例如提交代码之前进行代码格式化、测试等操作."husky"是一个为了方便使用Git hooks的工具，它能够帮助你在项目中自动化地执行一些Git相关的操作。使用husky，你可以在Git的一些关键操作（例如提交、推送、合并等）前或后，执行一些脚本或命令，比如代码格式化、自动化测试、打包发布等。
git commit提交规范
axzzy的博客
11-03 2220
📈 (上升趋势图) :chart_with_upwards_trend : 添加分析或跟踪代码。🏁 (旗帜) :checkered_flag : 修复 Windows 下的问题。🌐 (地球) :globe_with_meridians : 国际化与本地化。✅ (白色复选框) :white_check_mark : 增加测试。💚 (绿心) :green_heart : 修复 CI 构建问题。🐧 (企鹅) :penguin : 修复 Linux 下的问题。🔒 (锁) :lock : 修复安全问题。
git commit 规范
Aurora_juan的博客
04-25 181
公司管理git提交规范，在此记录一波，😊 格式：type(scope): subject type有以下类型 type：用于说明commit的类别，规定为如下几种 1. feat：新增功能； 2. fix：修复bug； 3. docs：修改文档； 4. refactor：代码重构，未新增任何功能和修复任何bug； 5. build：改变构建流程，新增依赖库、工具等（例如webpack修改）； 6. style：仅仅修改了空格、缩进等，不改变代码逻辑； 7. perf：改善性能和体现的修改； 8. cho
Git Commit提交规范总结
拾年一剑 的专栏
02-27 6277
团队协作中，规范的Git提交记录，使提交历史明确可追溯，有助于更好的协作，方便后期代码的开发和维护
Git commit规范
Cupster
04-15 1004
概述 Commit message 的写法规范有多种，其中Angular 规范是目前使用最广，比较合理和系统化，并且有配套的工具/插件 2.作用 1.方便快速浏览 $ git log <last tag> HEAD --pretty=format:%s 2.过滤查看指定类型 $ git log <last release> HEAD --grep feature 3.生成Change log npm install -g conventional-changelog $ cd m
git commit规范化
xm2by的博客
07-27 750
git commit规范化 项目中，每次使用git提交代码时都需要填写提交信息，每个人填写提交信息的风格都不一样，为了保持项目中git commit一致性，就需要对git commit进行规范化处理，规范的git commit 可以让项目的提交信息整洁明了，也可以让我们通过提交信息可以清晰的知道本次提交的内容，出现问题时也可以更快速的查询问题，如果项目需要生成changelog日志，规范的git ...
Git Commit提交规范和IDEA插件Git Commit Template的使用
热门推荐
noaman_wgs的博客
12-06 1万+
Git是最牛逼的开源分布式版本控制系统，日常开发中常用来管理代码提交、恢复、追踪，是团队开发最常用的一个代码管理工具。 在我们修改了代码并且提交之前，常会使用git commit -m 'change'命令来描述我们代码改动的内容，但是很多都不规范，随处可见的 git commit -m 'update'，以致于不能清晰地知道每次提交代码的变更内容，所以需要一种规范来管理代码提交的内容。 一、Gi...
git提交代码常用规范
12-30
git提交代码常用规范
git commit规范提交
酒无忧的博客
11-06 881
Git每次提交代码时，都要写Commit Message（提交说明），通常情况下，Commit Message应该清晰明了，说明本次提交的目的和具体操作等。例如，有些人会写此次代码的修改是基于哪个模块，有些人会写解决了哪些Bug，有些则只写修改了哪个文件，中英文混用等等五花八门的Commit格式，这导致后续的代码维护成本很高，有时候提交人看Commit Message都不知道自己改了什么。比如查阅某个业务的修改历史，查阅某个时间段修复了哪些Bug，因为Commit没有统一的格式，就比较难快速获取这些信息。
Git Commit 提交规范，变更日志、版本发布自动化和 Emoji 提交标准
ReturnTmp的博客
03-23 1905
Git Commit 是开发的日常操作, 一个优秀的 Commit Message 不仅有助于他人 Review, 还可以有效的输出 CHANGELOG, 对项目的管理实际至关重要, 但是实际工作中却常常被大家忽略，希望通过本文，能够帮助大家规范 Git Commit，并且展示相关 Commit 工具库或包，及相关变更日志和版本发布自动化工具commitizen git commit 格式化工具, 为我们提供标准化的 commit 信息。帮助我们统一项目 commit ，便于信息的回溯或日志的生成。
git commit 代码提交规范
辰风沐阳
08-08 2257
每个人 git 的提交记录都有自己的风格和习惯，特别是多人协作开发的项目，如果没有一套完整的规范，则每个人的代码提交描述内容会很随意，质量参差不齐，会降低 log 的可读性和维护性。所以，需要有一套 git 提交规范，使得提交记录清晰明了，让人一看就能知道每次提交的目的。本文记录一种业界比较认可和常用的规范，来自 AngularJS 团队规范。...
Git Commit 之道：规范化 Commit Message 写作指南
pursuit的博客
11-12 1万+
在软件开发的征程中，清晰明了的 Git Commit Messages 是项目成功的关键。本指南将教你如何通过规范化 Git 提交信息，提高代码可读性，以及如何巧妙撰写自动生成的 Change Logs，精准记录项目的演变。让你的团队与你共同领略 Git Commit 的精髓，推动项目可维护性的巅峰。
Git学习笔记（四）——commit建议规范
DivingKitten Coding驿站
02-10 1550
写在前面：笔记来源bilibili阿里云git系列课程 **Do one thing and do it well:**一个提交中只做一件完整的小事，一次把它做好 提交做小，方便评审，提交原子化，包含单个修改 一、提交节点修复 1、拆分提交 拆分当前提交： 回溯头指针，将当前提交的修改保留在工作区，从暂存区撤出 git reset HEAD~1 然后依次新增提交 git add -p git commit 2、拆分历史提交 首先回溯当前工作区和暂存区至需要修改的提交 git rebase -i .
git里commit-msg.sample可以删掉嘛
07-12
这个文件通常位于 `.git/hooks` 目录下，并非必需的，你可以选择保留它作为提交规范参考，也可以删除。 如果你确定自己已经了解并能够遵循良好的提交信息格式，删除 `commit-msg.sample` 没有问题，因为你可以在...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值