常用的Git commit 提交规范！

最新推荐文章于 2025-02-08 14:06:36 发布

嵌入式大杂烩

最新推荐文章于 2025-02-08 14:06:36 发布

阅读量1.2k

点赞数 5

分类专栏：工具/资源/技巧文章标签： git

本文链接：https://blog.youkuaiyun.com/zhengnianli/article/details/140190704

版权

在我们嵌入式开发中，版本管理工具Git已经成为不可或缺的一部分。

Git帮助我们记录代码变更历史，提供了强大的代码协作开发功能。

初学时，我们基本都是按照下面的格式这么来写commit信息的吧？

git commit -m "Fix Segmentation fault bug"

甚至有些公司的commit信息也很随意也类似于上面这样的。这样的commit信息包含的信息比较有限，不利于后续的版本追溯。

其实，为了确保团队成员能够更高效地协作，并且保持代码库的整洁和有序，需要团队各成员遵循达成一致的commit提交规范。

commit提交规范尽可能地包含一些能帮助我们对历史版本进行追溯的有用信息。

比如：能清晰地概述所提交的内容、能知道这个提交是bug修复还是功能新增、代码修改的地方、影响范围、是否经过自测等。

这个提交规范可以形成commit模板文件配置到git中。

commit模板配置

1、在用户目录下创建一个名为commit.template的模板文件。模板内容可参考如下：

<类型>: 主题

修改内容：
影响范围：
自测情况：
相关链接：

#1、类型：
# feat：新增 xxx 功能
# fix：修复 xxx bug
#

最低0.47元/天解锁文章

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

嵌入式大杂烩

关注关注

5
点赞
踩
10

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
打赏
打赏
打赏举报

举报

专栏目录

笔记——Git Commit 提交规范

蜡笔小谢的博客

01-16

5448

在团队协作中，合理的提交规范能够帮助开发者提高代码质量、简化代码审查流程，并促进更高效的团队协作。本文介绍 Git commit 提交规范的重要性，并分享一些最佳实践，帮助开发者更好地管理和记录代码提交。

git commit 规范指南

weixin_34375233的博客

04-13

1213

前言 Git 每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。但是，一般来说，commit message 应该清晰明了，说明本次提交的目的。不过话说回来，作为最具个人创造力和最会利用工具的物种——程序猿，最好是能有规范和工具的约束。否者的话，你可能看到以下的commit message：目前，社区...

参与评论您还未登录，请先登录后发表或查看评论

【工具使用系列】关于 git commit 信息规范，你需要知道的事

Allen-Moore的博客

06-21

370

如何写好 git commit 信息

Git Commit提交规范

qq_55262450的博客

10-13

2664

Git Commit提交规范

git commit规范提交

酒无忧的博客

11-06

1834

Git每次提交代码时，都要写Commit Message（提交说明），通常情况下，Commit Message应该清晰明了，说明本次提交的目的和具体操作等。例如，有些人会写此次代码的修改是基于哪个模块，有些人会写解决了哪些Bug，有些则只写修改了哪个文件，中英文混用等等五花八门的Commit格式，这导致后续的代码维护成本很高，有时候提交人看Commit Message都不知道自己改了什么。比如查阅某个业务的修改历史，查阅某个时间段修复了哪些Bug，因为Commit没有统一的格式，就比较难快速获取这些信息。

git commit提交规范

axzzy的博客

11-03

2871

📈 (上升趋势图) :chart_with_upwards_trend : 添加分析或跟踪代码。🏁 (旗帜) :checkered_flag : 修复 Windows 下的问题。🌐 (地球) :globe_with_meridians : 国际化与本地化。✅ (白色复选框) :white_check_mark : 增加测试。💚 (绿心) :green_heart : 修复 CI 构建问题。🐧 (企鹅) :penguin : 修复 Linux 下的问题。🔒 (锁) :lock : 修复安全问题。

Git Commit 提交规范

fushan2012的博客

02-08

1671

Git Commit 规范是一套约定俗成的规则，用于统一代码提交信息的格式和内容。它可以帮助团队更清晰地记录代码变更历史，方便回溯问题、生成更新日志（CHangelog）或自动化版本管理。一个规范的 Commit Message 通常包含和指明本次提交的featfixdocsstylerefactortestchoreperfcirevertfeat(user)fix(api)featfixfeatfix。

Git Commit提交规范总结

拾年一剑的专栏

02-27

6900

团队协作中，规范的Git提交记录，使提交历史明确可追溯，有助于更好的协作，方便后期代码的开发和维护

git commit 提交规范

青颜的天空的博客

03-21

4213

约定式提交规范是一种基于提交消息的轻量级约定。它提供了一组用于创建清晰的提交历史的简单规则；这使得编写基于规范的自动化工具变得更容易。这个约定与 SemVer 相吻合，在提交信息中描述新特性、bug 修复和破坏性变更。提交说明的结构如下所示： <类型>[可选的作用域]: <描述> [可选的正文] [可选的脚注] 大致分为三个部分(使用空行分割): 标题行: 必填, 描述主要修改类型和内容主题内容: 描述为什么修改, 做了什么样的修改, 以及开发的思路等等页脚注

Git Commit提交规范和IDEA插件Git Commit Template的使用

热门推荐

noaman_wgs的博客

12-06

1万+

Git是最牛逼的开源分布式版本控制系统，日常开发中常用来管理代码提交、恢复、追踪，是团队开发最常用的一个代码管理工具。在我们修改了代码并且提交之前，常会使用git commit -m 'change'命令来描述我们代码改动的内容，但是很多都不规范，随处可见的 git commit -m 'update'，以致于不能清晰地知道每次提交代码的变更内容，所以需要一种规范来管理代码提交的内容。一、Gi...

git commit的提交规范

初郁

06-16

1462

格式每次提交，Commit message 包括三个部分：Header（标题），Body（内容详情）和 Footer（结尾）。其中 Header是必须的，Body 和 Footer可以省略。 <type>(<scope>): <subject> // 空一行 <body> // 空一行 <footer> Header部分只有一行，包括两个字段：type（必需）和subject（必需）。 type 用于说明commit的类别，只允许有以

git commit 代码提交规范

辰风沐阳

08-08

2368

每个人 git 的提交记录都有自己的风格和习惯，特别是多人协作开发的项目，如果没有一套完整的规范，则每个人的代码提交描述内容会很随意，质量参差不齐，会降低 log 的可读性和维护性。所以，需要有一套 git 提交规范，使得提交记录清晰明了，让人一看就能知道每次提交的目的。本文记录一种业界比较认可和常用的规范，来自 AngularJS 团队规范。...

git commit 提交规范建议

Hoey的博客

02-03

440

在使用 `git commit -m` 时，遵循规范的提交信息格式可以提高代码可读性、协作效率和版本管理质量。记录常用的提交规范。

Git Commit 规范

DTCloud

06-13

1036

遵循 Git Commit 规范可以提高团队协作效率和代码库的可维护性。通过明确的 Commit 类型和格式，开发者能够更轻松地理解每个提交所带来的更改，并能够快速回溯和回滚代码。建议团队在项目中制定统一的 Git Commit 规范，并通过培训和代码审查来确保规范的遵循。这将有助于提升代码质量、减少问题和改进团队的协作流程。Git文档作者：郑集文。

git commit 提交规范举例

最新发布

02-13

### Git Commit Message 规范示例 #### 单行提交信息格式每次提交应当只解决一个问题，这有助于简化代码审查过程并提高可追溯性。单行提交信息应该简洁明了，通常不超过72个字符[^1]。 ```plaintext type(scope): subject ``` - `type` 表示更改的性质（如 feat, fix） - `scope` 是可选字段，用于指定受影响的部分或模块名称 - `subject` 描述所做的改动摘要 #### 完整多行提交信息结构对于更复杂的变更，则推荐采用如下完整的多行格式： ```plaintext type(scope): subject Body explaining the change and its motivation. Footer with any relevant issue references. ``` 其中： - **Header**: 包含三部分——类型(type)，作用域(scope)以及主题(subject) - **Body**: 对修改原因及实现细节做进一步解释说明；如果适用的话还可以提及如何测试这些变化。 - **Footer**: 如果有的话，在这里注明关联的问题编号或者其他元数据信息，例如关闭某个GitHub Issues。 #### 实际案例展示 ##### 添加新功能的例子当向项目中引入新的特性时，可以这样书写commit message: ```plaintext feat(user-profile): add avatar upload feature Allow users to upload avatars from their local machines or via URL links. This enhancement improves user experience by personalizing profiles. Closes #1234 ``` ##### 修复Bug的例子针对错误修正类别的提交消息则像下面这样表达: ```plaintext fix(authentication): resolve login redirect loop on Safari browser The previous implementation caused an infinite redirection when logging in using Safari due to incorrect handling of session cookies. The solution was implemented according to best practices outlined at MDN Web Docs regarding secure cookie settings. Fixes #9876 ``` #### 工具支持为了确保团队成员都能遵循一致的消息格式化规则，建议使用工具辅助验证。例如可以通过配置 pre-commit hook 来运行 validate-commit-msg 或者集成 CI/CD 流程中的检查脚本以自动拒绝不符合规定的提交请求[^3]。