Git commit格式参考

最新推荐文章于 2025-03-19 14:25:38 发布
最新推荐文章于 2025-03-19 14:25:38 发布
阅读量899 收藏 2
点赞数
分类专栏： Git 文章标签： git
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/noahsun1024/article/details/105037686
版权

前言

文章首发于Noah Sun’s Home Git commit格式参考，转载请注明出处，谢谢！

编写良好的Commit messages可以达到以下几个重要的目的

  • 加快review的流程
  • 帮助我们编写良好的版本发布日志
  • 让之后的维护者了解代码里出现特定变化和feature被添加的原因

目前，社区有多种 Commit message 的写法规范。来自Angular 规范是目前使用最广的写法，比较合理和系统化。如下图：
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-A2EGlMzg-1584887393563)(http://image.noahsun.top/git_commit_guidelines/angular_commit_example.jpg)]

Commit messages格式

当前业界应用的比较广泛的是 Angular Git Commit Guidelines

具体格式为:

<type>: <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

每个commit message一般包含header、body和footer，header是必须的，body和footer不做强制要求，所以一般可以简化为

<type>(<scope>): <subject>

或者省略scope

<type>: <subject>

说明

  • type: 本次 commit 的类型，诸如 bugfix docs style 等
  • scope: 本次 commit 波及的范围
  • subject: 简明扼要的阐述下本次 commit 的主旨
  • body: 同样使用祈使句，在主体内容中我们需要把本次 commit 详细的描述一下，比如此次变更的动机
  • footer: 描述下与之关联的 issue 或 break change，详见案例

例子

feat(jqLite): add prop() support
fix(ngStyle): correctly remove old style when new style value is invalid
docs(developers): commit message format typo
style(animator): style cleanup
refactor(filter): filters are now injectable and services
perf(*): don't trigger digests after enter/leave of structural directives
test(mocks): test mocks with compiled angular
chore(release): preparing release notes for 0.10.3

Type

类型必须是以下其中一种

  • feat: 新功能
  • fix: bug fix
  • docs: 只改了文档
  • style: 代码格式修改，不影响代码的逻辑性，比如空格，格式化，缺失分号等
  • refactor: 代码重构，既不是bug fix也不是新功能
  • perf: 性能优化
  • test: 补充或修改测试代码
  • chore: 改变构建流程，或者增加依赖库和工具等，比如增加文档生成工具

Scope

范围可以是指定提交更改位置的任何内容，比如search, location, browser, compile等

你可以使用*来代替多个范围

Subject

主题包含对变更的简洁描述，有几个要求

  • 使用祈使句和现代时，比如使用change而不是changed或者changes
  • 首字母不要大写
  • 句末无需使用句号

Body

主体与主题一样，应使用祈使句和现代时，应包括改变的动机，并将其与以前的行为进行对比。

Footer

描述一些重大的修改和相关的问题，详情参考 AngularJS Message footer

Revert

当回滚提交时，必须以 revert: 作为开头然后紧跟着该提交的header。

body部分可以这样描述


This reverts commit <hash>.

hash是将要被回滚的那个提交的SHA码。

参考

您必须知道的 Git 分支开发规范
angular.js-git-commit-guidelines
AngularJS Git Commit Message Conventions

Git commit 消息的格式与约定式提交
成富的专栏
06-09 1625
在开发人员的日常工作中，提交代码到 Git 是必不可少的动作。代码提交时的消息该怎么写呢？最基本的原则是：如果团队有 commit 格式要求，就遵循该要求。这一点与代码风格是一样的。commit 消息的格式没有绝对的好与坏，最重要的是保持一致性。如果团队没有具体的格式要求，可以参考下面的一些建议。消息应该分成主题和内容两个部分，两部分用一个空行分隔。主题部分对 commi...
git cz 规范化 git commit 格式
weixin_44240581的博客
09-07 889
git cz 规范化 git commit 格式，相关库（git-cz、commitizen、cz-customizable、husky）
git commit规范梳理
YouZi_X的博客
08-14 876
commit message格式 <type>(<scope>): <subject> type(必须) 用于说明git commit的类别，只允许使用下面的标识。 feat：新功能（feature）。 fix/to：修复bug，可以是QA发现的BUG，也可以是研发自己发现的BUG。 fix：产生diff并自动修复此问题。适合于一次提交直接修复问题 to：只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix docs：文档（docu
标准 Git Commit 模板格式指南
此人有点怪，时发时不发。
03-19 358
✅ 标准 Git Commit 模板格式指南 ## 格式模板 ``` <type>(<scope>): <subject> <body> ← 可选，详细说明做了什么，为啥这么做
Git commit格式 详解
u013803262的专栏
03-18 1万+
我们在使用git进行版本控制的时候,commit的格式是有要求的。我们可以先去看一些顶级项目他们的commit的格式是怎样的。angular在github上的commit信息 我们可以发现 commit都有一些前缀,比如说 feat test chore fix refactor docs现在我们来讲解git commit信息的格式Commit Message 格式<type
4. git规范 - commit格式
Var_YanGuangYing
12-10 773
Header部分只有一行，包括三个字段：type（必需）、scope（可选）和subject（必需）。 type 用于说明 commit 的类别，只允许使用下面7个标识。 feat：新功能（feature） fix：修补bug docs：文档（documentation） style： 格式（不影响代码运行的变动） refactor：重构（即不是新增功能，也不是修改bug的代码变动） test：增加测试 chore：构建过程或辅助工具的变动 ...
Git Commit 之道：规范化 Commit Message 写作指南
pursuit的博客
11-12 1万+
在软件开发的征程中，清晰明了的 Git Commit Messages 是项目成功的关键。本指南将教你如何通过规范化 Git 提交信息，提高代码可读性，以及如何巧妙撰写自动生成的 Change Logs，精准记录项目的演变。让你的团队与你共同领略 Git Commit 的精髓，推动项目可维护性的巅峰。
commit-msg-linter:git commit消息linter钩子
05-03
欢迎来到git-commit-msg-linter :waving_hand: :eyes: 立即查看您的每条git commit消息 :rocket: 。 一个git“ commit-msg”挂钩，用于根据流行的来替换您的git commit消息。 作为一个挂钩，它将在每次提交时运行...
【知识整理】Git Commit Message 规范
李木
02-23 2996
前面咱们整理过Code Review 一文，提到了 Review 的重要性，已经同过gitlab进行CodeReview 的方式，那么本文详细说明一下对CodeReivew非常重要的Git Commit Message 规范。我们在每次提交代码时，都需要编写 Commit Message，否则是不允许提交的。书写好的 Commit Message 能大大提高代码维护的效率。避免开发人员在项目中群魔乱舞，搞得代码一团糟，搞的项目就被糟践了。且开发日后的维护，都将是灾难。
Git Commit提交规范和IDEA插件Git Commit Template的使用
热门推荐
noaman_wgs的博客
12-06 1万+
Git是最牛逼的开源分布式版本控制系统，日常开发中常用来管理代码提交、恢复、追踪，是团队开发最常用的一个代码管理工具。 在我们修改了代码并且提交之前，常会使用git commit -m 'change'命令来描述我们代码改动的内容，但是很多都不规范，随处可见的 git commit -m 'update'，以致于不能清晰地知道每次提交代码的变更内容，所以需要一种规范来管理代码提交的内容。 一、Gi...
git commit 规范
yanzi_0216的博客
11-19 1499
git commit 规范目的commit message格式type(必须)scope(可选)subject(必须)git hooks 转载自 https://zhuanlan.zhihu.com/p/182553920 mark 一下，方便查看 目的 git commit 规范的主要目的是为了规范化 commit 格式，使每次的 commit 清晰指明本次提交的目的、备注信息以及影响范围。 commit message格式 <type>(<scope>): <subje
git commit规范
weixin_51474815的博客
01-23 8147
如何规范git commit提交 github是我们用于协同开发的平台，方便开发人员协同开发，极大提高了开发效率，但是经过团队第一次协同开发后，我们发现了一个很大的问题，我们的git commit非常不规范，至于在开发后期项目出现bug之后，很难找到问题所在，为了规范以后的开发，学习使用commitizen,husky以及standard-version来规返回git commit提交，并且自动化生成CHANGLOG commitizen commitizen是用来制定git commit规范的工具 首先让
Git Commit的正确姿势
行云流水
09-26 1万+
Commit message 的格式每次提交，Commit message 都包括三个部分：Header，Body 和 Footer。<type>(<scope>): <subject>// 空一行<body>// 空一行<footer> 其中，Header 是必需的，Body 和 Footer 可以省略。不管是哪一个部分，任何一行都不得超过72个字符（或100个字符）。这是为了避免自动换行影响美观
Git Commit提交规范
qq_55262450的博客
10-13 2534
Git Commit提交规范
Git commit提交规范
小小渔夫
12-13 764
使用git管理代码的同行，我们经常能看到其他人代码提交时的备注写的过长，有的看不懂，有的太过间接，本文旨在简单说明git commit提交的规范，规范提交内容。
commitizen（git commit format）
allen的博客
12-06 260
Install npm install commitizen install sudo npm install -g commitizen first project config config cd Path_Git_Porject # base config commitizen init cz-conventional-changelog --save --save-exa...
git：git commit 书写格式
JNing
07-04 2331
git commit 的来源 & 如何使用   正如 git add 的作用是将文件放入暂存区， git commit 的作用是将修改提交到分支上。   如果只写一句话，那么以下指令即可： git commit -m 'Hello Commit !'   如果想写一整段话，那么输入以下指令，可跳转到文本编辑器界面大书特书： git commit   目前，社区有多种 Com
Git - Git Commit 格式规约
陆克和他的那些代码
02-23 662
俗话说，无规矩不成方圆。 前段时间，阿里诚意献上重磅大礼：《阿里巴巴Java开发手册》，首次公开阿里官方Java代码规范标准。这套Java统一规范标准将有助于提高行业编码规范化水平，帮助行业人员提高开发质量和效率、大大降低代码维护成本。 那么问题来了，Git提交日志是否需要规范化呢？答案是肯定的。 此时，请允许我班门弄斧附图一张 一目了然，整齐划一，有木有？同时也更能快速定位节点做过什么操作。 提交日志基本格式 <type>(<scope>): <s..
git commit格式 git branch命名格式
eehongzhijun的博客
09-04 147
git commit格式 在Git中，git commit命令用于将文件的更改提交到版本控制仓库。提交消息是非常重要的，因为它记录了对项目的更改的描述和目的。提交消息的格式通常遵循一些约定，以便更容易理解和维护项目的历史。以下是一种常见的提交消息格式： <类型>(可选范围): <主题> <正文> # 评论或注释(可选) <类型>(必需)：表示此...
git commit是什么
最新发布
04-02
<think>好的，用户想了解git commit的定义和使用方法。首先，我需要明确git commit在版本控制系统中的作用。记得git commit是将暂存区的更改保存到本地仓库的操作，这应该是核心点。然后，用户可能还不太清楚基本流程，比如需要先add再commit，这里需要分步骤说明。 接下来，用户可能遇到常见问题，比如如何写提交信息、修改提交或者撤销操作。这些是实际使用中常遇到的，需要给出具体命令和示例。例如，git commit -m直接添加信息，而git commit --amend用来修改最近的一次提交。 另外，用户提供的参考引用里有提到Commitizen和Git Auto Commit Action，这些工具可以优化提交过程，可能需要简要介绍一下，但不要偏离用户的主要问题。比如Commitizen引导生成规范的提交信息，适合团队协作时使用，而GitHub Action自动化提交，适合CI/CD流程。 还要注意回答的结构，先定义，再使用方法，分步骤说明，然后常见问题，最后扩展工具。确保每个部分清晰，用例子帮助理解。比如在基本用法里给出命令行示例，这样用户可以直接复制使用。 需要检查是否有遗漏的重要点，比如提交信息的重要性，良好的习惯对团队协作的影响。可能用户没问，但作为最佳实践应该提及。同时，确保所有引用正确对应，比如引用[2]关于git status和提交命令的顺序，引用[1]提到Commitizen的使用方法。 最后，生成的相关问题要围绕git commit的扩展，比如规范、撤销方法、与push的区别，以及自动化工具。这些问题可以帮助用户进一步深入学习，解决可能遇到的后续疑问。</think>### Git Commit的定义及使用方法 #### 一、Git Commit的定义 Git commit 是Git版本控制系统中将**暂存区（Staging Area）**的修改永久记录到本地仓库的操作。每次提交会生成唯一的40位SHA-1哈希值标识，并包含提交者信息、时间戳和提交注释[^2]。 #### 二、基本使用流程 1. **添加修改到暂存区** ``` git add <文件名> # 添加单个文件 git add . # 添加所有修改 ``` 2. **执行提交操作** ``` git commit -m "提交说明" ``` 示例：`git commit -m "修复用户登录验证逻辑"` 3. **验证提交状态** 使用 `git log` 查看提交记录，`git status` 确认工作区状态[^2] #### 三、进阶用法 | 场景 | 命令 | 说明 | |---------------------|--------------------------------------|-----------------------------| | 修改最近提交 | `git commit --amend -m "新说明"` | 可修正提交信息或追加文件[^3] | | 空提交（触发CI/CD） | `git commit --allow-empty -m "提示"` | 常用于流水线触发场景 | | 跳过预提交钩子 | `git commit --no-verify` | 紧急情况下绕过检查 | #### 四、提交规范建议 推荐采用[Conventional Commits](https://www.conventionalcommits.org/)规范： ```bash git commit -m "feat(用户模块): 新增手机号验证功能" git commit -m "fix(API): 修复分页参数溢出问题" ``` #### 五、常见问题解决 1. **误提交文件** ``` git reset HEAD~1 # 撤销最近一次提交 git reset --soft HEAD~1 # 保留修改到暂存区 ``` 2. **提交信息错误** ``` git commit --amend # 进入Vim编辑器修改 ``` 3. **部分文件漏提交** ``` git add missing_file.txt git commit --amend --no-edit ``` #### 六、扩展工具推荐 1. 使用**Commitizen**规范化提交（引用[^1]）： ``` npm install -g commitizen git cz # 替代git commit ``` 2. **Git Auto Commit Action**（引用[^4]）可自动执行提交操作，适用于CI/CD流程
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值