加入星计划,您可以享受以下权益:

  • 创作内容快速变现
  • 行业影响力扩散
  • 作品版权保护
  • 300W+ 专业用户
  • 1.5W+ 优质创作者
  • 5000+ 长期合作伙伴
立即加入
  • 正文
    • commit模板配置
  • 推荐器件
  • 相关推荐
  • 电子产业图谱
申请入驻 产业图谱

常用的 Git 提交规范!

07/06 09:25
1206
阅读需 4 分钟
加入交流群
扫码加入
获取工程师必备礼包
参与热点资讯讨论

在我们嵌入式开发中,版本管理工具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是这样子的:

比较清晰明了!

推荐器件

更多器件
器件型号 数量 器件厂商 器件描述 数据手册 ECAD模型 风险等级 参考价格 更多信息
HFBR-1521Z 1 Foxconn Transmitter, 5Mbps, DIP, Through Hole Mount, ROHS COMPLIANT PACKAGE
$17.03 查看
531FB160M000DGR 1 Silicon Laboratories Inc LVDS Output Clock Oscillator, 10MHz Min, 945MHz Max, 160MHz Nom, ROHS COMPLIANT PACKAGE-6
$28.99 查看
KSZ8001LI 1 Microchip Technology Inc DATACOM, ETHERNET TRANSCEIVER, PQFP48
$5.15 查看

相关推荐

电子产业图谱

本公众号专注于嵌入式技术,包括但不限于C/C++、嵌入式、物联网、Linux等编程学习笔记,同时,公众号内包含大量的学习资源。欢迎关注,一同交流学习,共同进步!