当前位置: 首页 >  开发指南 >  git提交规范

git提交规范

导读:在团队协作中,Git 提交规范对于代码的可维护性和版本管理非常重要。下面总结了一些常见的提交规范:.提交信息格式.每个 Git 提交信息都应该包含一个清晰简洁的标题和一个更详细的描述。推荐的提交信息格式如下:.<type>(<scope>): <subject>.<BLANK L

在团队协作中,Git 提交规范对于代码的可维护性和版本管理非常重要。下面总结了一些常见的提交规范:

提交信息格式

每个 Git 提交信息都应该包含一个清晰简洁的标题和一个更详细的描述。推荐的提交信息格式如下:

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

其中,<type> 代表提交类型,<scope> 代表影响范围,<subject> 是提交信息的简短描述,<body> 是详细描述,<footer> 是一些元数据,比如关联的 issue、PR 等。

提交类型

常见的提交类型包括:

  • feat:新功能
  • fix:修复 bug
  • docs:文档修改
  • style:代码格式修改,比如缩进、空格等
  • refactor:代码重构
  • test:测试相关修改
  • chore:其他修改,比如构建流程、辅助工具等

影响范围

<scope> 表示影响的范围,可以是文件名、模块名、功能名等,也可以省略不写。

提交信息示例

下面是一个示例提交信息的格式:

feat(proto-gen): 协议导出c++

支持协议自动生成c++代码

Closes #123

在这个示例中,feat(proto-gen) 表示添加了新功能,协议导出c++ 是简要描述,支持了协议导出c++代码, 支持协议自动生成c++代码 是提交信息的详细描述,Closes #123 表示关联了 Issue #123。

总结

遵循 Git 提交规范可以让团队协作更加高效和规范,也更容易进行版本管理和代码维护。希望大家都能养成良好的提交习惯!

内容
  • IT团队如何引领企业走向创造价值的新途径?
    IT团队如何引领企业走向创造价值
    2023-12-08
    随着疫情结束带来的经济回暖,我们无疑已做好了更充分的准备。信息技术使许多企业能够在关门歇业的情况下继续运营,以防止大规模
  • awk 处理 Git 提交信息生成 Release Note
    awk 处理 Git 提交信息生
    2023-12-05
    发布软件时通常都会写 Release Note,但每次从头手打也有点累,可以考虑从 Git 的提交历史中自动生成。.Gi
  • 数据安全风险评估思路
    数据安全风险评估思路
    2023-12-05
    最早是“信息安全风险评估”,随着信息安全领域的细化,衍生出“数据安全风险评估”。.共同目标是保护数据的CIA安全三要素,
  • git 常用指令与简单规范
    git 常用指令与简单规范
    2023-12-04
    1. 前言.随着前端项目数量、前端开发人员、前端业务的日渐增多,则非常有必要整理一份简单的 git 规范,来进行项目开发
  • 学系统集成项目管理工程师(中项)系列06a_信息系统安全管理(上)
    学系统集成项目管理工程师(中项)
    2023-12-04
    1. 信息安全.1.1. 保护信息的保密性、完整性、可用性.1.2. 另外也包括其他属性,如:真实性、可核查性、不可抵赖
  • 通过命令修改git提交的注释信息
    通过命令修改git提交的注释信息
    2023-12-04
    1.修改最新一条 commit 注释信息.通过 git commit –amend 命令修改注释信息,然后:wq 进行保
  • 密码学基础知识
    密码学基础知识
    2023-12-01
    一、安全原则.信息安全三要素(CIA):机密性(confidential)、完整性(integrality)、可用性(a
  • 可爱儿童内衣套装,优质棉质,柔软透气,呵护宝宝肌肤
    可爱儿童内衣套装,优质棉质,柔软
    2024-01-05
    可爱儿童内衣套装,优质棉质,柔软透气,呵护宝宝肌肤.宝宝的皮肤是非常娇嫩的,所以选择合适的内衣套装对于宝宝的健康和舒适至
  • 时尚潮流运动鞋
    时尚潮流运动鞋
    2024-01-15
    时尚潮流运动鞋.时尚潮流运动鞋一直是年轻人喜爱的时尚单品,它不仅舒适耐穿,更是一种个性的象征。随着时尚潮流不断更新,运动
  • 修身弹力牛仔裤
    修身弹力牛仔裤
    2023-12-26
    修身弹力牛仔裤:展现你的魅力.一、时尚的必备单品.修身弹力牛仔裤一直都是时尚界的必备单品,它不仅可以展现出个人的魅力,还
  • 休闲简约短袖衬衫
    休闲简约短袖衬衫
    2023-12-21
    休闲简约短袖衬衫.现代人生活节奏快,休闲简约的穿着成为时尚潮流。短袖衬衫作为经典的休闲单品,一直备受时尚人士的青睐。它舒
  • 休闲宽松T恤衫,释放自在舒适气息
    休闲宽松T恤衫,释放自在舒适气息
    2023-12-26
    休闲宽松T恤衫,释放自在舒适气息.在这个喧嚣的都市中,人们的生活节奏变得越来越快,压力也越来越大。因此,人们更加注重舒适
  • 潮流风衣大衣,彰显都市时尚风采
    潮流风衣大衣,彰显都市时尚风采
    2023-12-16
    潮流风衣大衣,彰显都市时尚风采.潮流风衣大衣一直是时尚界备受追捧的单品之一。它既能为我们遮风挡雨,又能为我们穿出时尚感,
  • 时尚修身连衣裙,展现优雅女性魅力
    时尚修身连衣裙,展现优雅女性魅力
    2023-12-06
    时尚修身连衣裙,展现优雅女性魅力.时尚修身连衣裙一直是女性衣橱里的必备单品,不仅款式多样,而且能够展现出女性的优雅魅力。
  • 保暖舒适羊毛大衣
    保暖舒适羊毛大衣
    2024-01-05
    保暖舒适羊毛大衣.冬季来临,寒冷的天气让人们更加注重保暖。在这个时候,一件保暖舒适的羊毛大衣成为了许多人的首选。羊毛大衣
  • 萌娃配饰套装,包包、帽子、围巾等,增添宝宝的时尚气息
    萌娃配饰套装,包包、帽子、围巾等
    2024-01-20
    萌娃配饰套装,为宝宝增添时尚气息.宝宝是家庭的小太阳,****们都希望给他们最好的一切。随着时尚的发展,宝宝的时尚潮流也
  • 轻盈雪纺衬衫,打造清新淑女形象
    轻盈雪纺衬衫,打造清新淑女形象
    2023-12-31
    轻盈雪纺衬衫,打造清新淑女形象.雪纺材质的衬衫一直以来都是清新淑女形象的代表,它轻盈飘逸的质地,柔软透气的触感,让人仿佛