常用的Git commit 提交规范!

wptr33 2025-05-14 17:09 30 浏览

在我们嵌入式开发中，版本管理工具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
# refactor：重构 xxx
# test：测试 xxx
# chore：维护 xxx
# style：变更代码格式、修改注释
# docs：变更 xxx 文档

#2、主题：
# 简单描述本次提交的内容

#3、修改内容：
# 修改了xxx模块/修改了xxx文件/把xxx处理修改为yyy处理等。没有则填无。

#4、影响范围：
# 影响了xxx模块/影响了xxx路径的操作等。没有则填无。

#5、自测情况：
# 测试代码xxx_unit_test.c/测试了xxx路径/待联调测试等。没有则填无。

#6、相关链接：
# 需求链接/bug链接/设计文档链接等。没有则填无。

这个模板只是列举了常用的几个点，仅供参考，可以根据实际需要修改、添加、删除。

2、在git中配置模板

（1）全局使用这个commit message模板

输入如下命令：

git config --global commit.template ~/commit.template

（2）在当前仓库中使用此模板

在当前仓库的根目录下，打开命令行，输入如下命令：

git config commit.template ~/commit.template

3、设置commit时使用的编辑器

（1）配置全局有效：

git config --global core.editor vim

（2）配置当前有效：

git config core.editor vim

commit模板使用

git add添加代码到暂存区之后，输入git commit调用模板，使用vim编辑器填写内容。

保存退出，通过git log查看我们的commit是这样子的：

比较清晰明了！

如果文章对你有帮助，麻烦帮忙点赞、收藏、转发，谢谢！

私信回复【嵌入式书籍】，可获取博主精心整理的嵌入式电子书一份

git commit

上一篇：更改git提交历史中的注释(Commit Message )
下一篇：git撤销commit

常用的Git commit 提交规范!

commit模板配置

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

2、在git中配置模板

3、设置commit时使用的编辑器

commit模板使用

相关推荐

程序员的开源月刊《HelloGitHub》第 71 期

如何将AI助手接入微信（打开ai手机助手）

SparkSQL——DataFrame的创建与使用

使用过 Redis 分布式锁么，它是什么回事?

VUE循环语句的使用(v-for)（vuefor循环的key）

HiveOs系统教程最细手把手教学（hiveos启动）

Python rembg 库去除图片背景

HIVE SQL基础语法（hive-sql）

Spring Boot 概述（spring boot干嘛的）

《循环(for/while)》（循环while语句）