推荐的 git commit 规范

最新推荐文章于 2023-06-13 09:20:37 发布
最新推荐文章于 2023-06-13 09:20:37 发布
阅读量505 收藏 1
点赞数 1
分类专栏： 工具 文章标签： git
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Trend_H/article/details/107235162
版权

博客地址：git commit 使用及规范

一、前言

日常开发中，保持良好的代码规范有利于提高项目的质量。而指定并遵守 git commit 的使用规范，则有利于提高项目的管理效率。

二、提交格式

在git add后，需要执行git commit进行提交，如、约定中应添加对应的描述信息，即通过：git commit -m 进行提交
提交格式如下：

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

type表示提交类别，scope表示修改范围，subject表示标题行， body表示主体描述内容。
<BLANK LINE>表示为空行，不填写任何内容

1、type说明

type 是 commit 的类别，只允许以下几种标识

  • feat: 添加新特性
  • fix: 修复bug
  • docs: 文档改变
  • style: 代码格式改变，不改变代码逻辑
  • refactor: 代码重构，没有加新功能或者修复bug
  • perf: 优化相关，比如提升性能、体验
  • test: 增加测试代码
  • chore: 改变构建流程、或者增加依赖库、关联包升级、工具等
  • revert: 回滚到上一个版本
2、scope说明【可选】

非必填（建议填写），scope用于说明 commit 影响的范围，建议填写影响的功能模块。
如果你的修改影响了不止一个scope，你可以使用*代替。

3、subject说明
  • 必填， commit 目的的简短描述，不得超过50个字符。
  • 推荐以动词开头，如： 设置、修改、增加、删减、撤销等
  • 使用第一人称现在时，比如change，而不是changed或changes
  • 第一个字母小写
  • 结尾不加句号
4、body说明【可选】

非必填（建议填写），可描述当前修改的行为详细信息或修改的目的。

5、footer说明

非必填，一般用于描述BREAKING CHANGE，在项目开发中一般不需要填写，组件研发的工程需要填写。
Footer 部分只用于两种情况。
（1）不兼容变动
如果当前代码与上一个版本不兼容，则 Footer 部分以 BREAKING CHANGE 开头，后面是对变动的描述、以及变动理由和迁移方法。

BREAKING CHANGE: 提升依赖版本，不再支持12.0.0一下版本

（2）关闭 Issue
如果当前 commit 针对某个issue, 那么可以在 Footer 部分关闭这个 issue，也可以一次关闭多个 issue

Closes #234

三、提交方式

执行git commit后，命令行进入vim编辑器，按照上述规定的格式在注释前加入要提交的commit信息。

# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
#
# On branch master
# Your branch is up to date with 'origin/master'.
#
# Changes to be committed:
#       new file:   source/_posts/011.md
#
# Changes not staged for commit:
#       modified:   package-lock.json
#       modified:   package.json
#       modified:   themes/next (modified content, untracked content)
#

输入完成后，保存文件，执行 git push 命令，提交完成。

青冥有晓月

细语轻言
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
git的commit模板及commit规范校验工具一键安装
08-12
使用方式： 1、解压package.rar package.rar 2、进入package文件夹，右键打开git bash 3、执行 sh install.sh 进行安装，按提示选择是否安装提交日志校验模板和提交模板 4、执行git init 命令，查看当前目录是否生成 .git/gitcommit 和 .git/hooks/commit-msg 验证
git commit 规范指南
weixin_34375233的博客
04-13 772
前言 Git 每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。但是，一般来说，commit message 应该清晰明了，说明本次提交的目的。 不过话说回来，作为最具个人创造力和最会利用工具的物种——程序猿，最好是能有规范和工具的约束。否者的话，你可能看到以下的commit message： 目前，社区...
Git commit规范
latte_miao的博客
08-13 470
背景 记录看到的一片关于git commit时msg的编写规范 Git每次提交代码都需要写commit message，否则就不允许提交。一般来说，commit message应该清晰明了，说明本次提交的目的，具体做了什么操作……但是在日常开发中，大家的commit message千奇百怪，中英文混合使用、fix bug等各种笼统的message司空见怪，这就导致后续代码维护成本特别大，有时自己都不知道自己的fix bug修改的是什么问题。基于以上这些问题，我们希望通过某种方式来监控用户的git commi
git commit规范
mimsmile的博客
09-10 143
Commit Message 格式 <type>(<scope>): <subject> <空行> <body> <空行> <footer> 上述提交分为三个部分，头部，主体，底部 首先是头部，<type>(<scope>): <subject> 包括了三个节点： ...
Git commit 规范
路漫漫其修远兮，吾将上下而求索！
07-26 2625
在多人协作项目中，良好的 commit 风格如下所示 这里使用的工具是 commitlint。 1 Commitlint message 的格式 Commitlint 基于 Angular 的规范。很多工具也是基于此规范, 它的 message 格式如下: // Header &lt;type&gt;(scope): &lt;subject&gt; // 空一行 Body // 空一行...
Git Commit 规范1
08-03
Git Commit 规范格式于说明 git commit 的类别，只允许使下的标识feat: 新功能(feature)bug: 发现 bug，但没有修复doc
git-commit-lint-vscode:vscode一款git 规范化提交插件
05-17
git-commit-lint-vscode 在日常的开发中,目前主流的代码管理工具就是 git 了,当我们对代码进行改动了,首先得git commit提交到本地仓库,git 规定了提交时必须填写...所以git commit规范下还是很有必要的! 说明 类型 emji
git commit提交信息修改
01-20
git commit --amend 2 例子 git commit 输入以下数据： feat: test commitlint test commitlint test commitlint of the project 根据commitlint规范的提示，得到如下的数据提示，但是我又强迫症 husky > commit...
git-commit-style-guide：使git commit消息更易读和有用
02-03
统一团队的Git工作流，包括分支使用，标签规范，问题等Git commit日志参考案例总体方案Git提交日志基本规范(): <subject><BLANK><body><BLANK><footer>所有的类型类型如下： 类型代表某人次提交的类型，某种是...
Git Commit 规范
最新发布
DTCloud
06-13 806
遵循 Git Commit 规范可以提高团队协作效率和代码库的可维护性。通过明确的 Commit 类型和格式，开发者能够更轻松地理解每个提交所带来的更改，并能够快速回溯和回滚代码。建议团队在项目中制定统一的 Git Commit 规范，并通过培训和代码审查来确保规范的遵循。这将有助于提升代码质量、减少问题和改进团队的协作流程。Git文档作者：郑集文。
git commit 规范
m0_52537576的博客
07-10 304
一般一条commit包含例如：feat:完成首页chore(release): v0.0.2

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值