news 2026/9/6 14:50:00

git commit message 格式规范

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
git commit message 格式规范

在工作中,我们肯定会与git打交道。那么当你提交代码后如何让别人很快了解到你此次提交代码的改动点是哪些。此时就需要一个提交信息来描述此次提交修改的内容。没有格式的提交信息,会使提交记录杂乱无章,不能很快的定位哪些提交涉及代码修改,哪些只是配置修改等等。而好的提交信息能使提交历史更容易阅读,找到你想要的信息。这篇文章将整理 Angular 代码仓库制定的提交规范。

在该格式中,提交消息由三部分构成headerbodyfooter

<header><BLANK LINE><body><BLANK LINE><footer>

在日常工作中我们一般只用headerbodyfooter一般不会用,但是当你需要提 PR 到别人库时会被要求写这两部分。以下是各部分职责以及格式。

header 格式

<type>(<scope>):<shortsummary>│ │ │ │ │ └─⫸Summaryin presenttense.Notcapitalized.Noperiod at the end.│ │ │ └─⫸CommitScope:common|core|packaging|service|page|component|config │ └─⫸CommitType:build|ci|docs|feat|fix|perf|refactor|style|test|deps

其中,typeshort summary是必须要有的,scope为可选字段。

type 类型

type用于标记此次提交的类型。

  • feat:新增功能
  • fix:bug修复
  • docs:文档相关改动
  • style:对代码的格式化改动,代码逻辑并未产生任何变化
  • refactor:重构代码或者其他优化举措,理论上不影响现有功能
  • perf:提升性能
  • test:新增或者修改测试用例
  • build:项目工程化方面的改动,代码逻辑并未产生任何变化。(包括但不限于文档,代码生成等)
  • ci:CI配置文件和脚本的更改
  • deps:升级依赖

scope

scope用于标记此次修改文件的范围。这个范围可以对应某个功能或者文件夹都可以。

short summary

short summary用于描述此次提交的内容,应言简意赅。

  • 使用祈使句、现在时:如应该使用change而不是changed或者changes
  • 不要大写第一个字母
  • 句末没有句号

body

补充short summary,适当增加原因,目的等相关因素,用于说明更改的动机。也可以将此次提交与现有功能(或代码)比较说明更改的影响。

footer

footer可以包含一些重大的更改信息,比如非兼容性修改之类的信息需要在此描述清楚。也可以引用相关的 issue,或者其他 PR 等。

🌰

如 Angular 代码库的 PR 记录:https://github.com/angular/angular/pulls

传送门:
Angular Commit Message Format (https://github.com/angular/angular/blob/master/CONTRIBUTING.md)

版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/9/6 14:49:07

基于改进A*算法的机器人路径规划优化实践

简介&#xff1a;针对移动机器人全局路径规划中的局部最优、转折点多和动态避障不足等问题&#xff0c;这份PDF研究论文提出了基于改进A星算法的解决方案&#xff0c;主要面向机器人、机器学习及相关领域的工程师与研究者。资源为单篇论文&#xff0c;共1个文件&#xff0c;大小…

作者头像 李华
网站建设 2026/9/6 14:49:02

STM32 SPI通信调试:从CS建立时间到时钟模式的完整排查

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

作者头像 李华
网站建设 2026/9/6 14:48:56

线上演出直播系统架构:高并发、低延迟与CDN实战解析

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

作者头像 李华
网站建设 2026/9/6 14:48:54

电气主接线设计从识图到选型:变配电所核心逻辑全解析

简介&#xff1a;这是一份围绕变配电所电气主接线的专业教学课件&#xff0c;面向电气工程、供配电技术方向的学生&#xff0c;以及需要识读主接线图的运行维护人员。课件从系统式和装置式两种绘制形式切入&#xff0c;对比二者在运行管理、施工安装中的不同适用场景&#xff0…

作者头像 李华
网站建设 2026/9/6 14:46:16

力学基础知识复习指南:从受力分析到动量守恒的体系化框架

简介&#xff1a;这是一份面向初中物理学习者的力学基础复习资料&#xff0c;围绕力的示意图、平衡力、摩擦力、运动状态改变、重力与惯性等核心概念展开&#xff0c;通过小车受力、电灯悬挂、标枪前行、火箭升空等典型情境帮助读者巩固基础知识&#xff0c;适合学生考前自测、…

作者头像 李华
网站建设 2026/9/6 14:41:49

基于Qt的局域网聊天工具开发:C/S架构、TCP通信与粘包处理

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

作者头像 李华