百度360必应搜狗淘宝本站头条
当前位置:网站首页 > IT技术 > 正文

实际工作中 Git Commit 代码提交规范是什么样的?

wptr33 2025-06-09 00:41 3 浏览

前言

Git 是我们日常工作中使用最为广泛的分布式版本代码控制系统,因此在我们的实际工作中,git commit 代码提交规范能够让每一次代码提交都变得有据可循,方便后续的代码审查、问题追踪和版本管理。同时,规范的提交信息也能够为自动化工具提供便利,如生成变更日志、自动化部署等。

git commit 规范写法示例

首先我们一起来看看行业统一认可且标准的 angular 项目的 git commit 规范写法。

  • https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular

基本格式

首先一个规范的 git commit message 通常包含 Header、Body 和 Footer 三部分,各部分之间使用空行分隔。

<header>
// 空一行
<body>
// 空一行
<footer>

Header 必填

描述提交类型和简短说明。格式为:<类型>(<作用域>): <主题>(<type>(<scope>): <subject>)。

  • 类型(Type): 必填,指明本次提交的目的,如 feat 表示新开发的功能(feature)、fix 表示修复 bug、refactor 表示代码重构等。
  • 作用域(Scope): 可选,描述修改的影响范围,如模块名、功能名等,视项目不同而不同。
  • 主题(Subject): 必填,是 commit 简明扼要的提交描述。长度建议不超过 50 个字符。
feat(payment): 微信支付功能集成

Body 可选

详细说明本次 commit 修改的内容。使用空行分隔段落,保持可读性。

- 新增微信支付SDK依赖
- 实现支付结果回调处理
- 添加支付相关的单元测试

Footer 可选

主要用于关联 Issue、描述破坏性变更(BREAKING CHANGE)等。

Closes #889
BREAKING CHANGE: 旧版支付回调接口已废弃,需迁移至 /api/v2/callback

实际工作常用的 git commit 规范写法

其实在实际开发工作中很多时候我们主要关注和使用的是 git commit message 的 Header 部分。Header 通常包含了提交的类型、作用域和简短的主题描述,这些信息对于快速了解每次提交的内容和目的已经足够。

描述提交类型和简短说明。格式为:<类型>(<作用域>): <主题>

格式:type(scope) : subject

常用的提交类型包括

提交类型
描述
示例
feat
新功能增加(feature)
feat: add user login feature
fix
修复BUG
fix: correct user authentication
refactor
代码重构(既不是新增功能,也不是修复 Bug)
refactor: simplify user validation logic
docs
文档/注释
docs: update API documentation
style
代码风格相关无影响运行结果的
style: format code with prettier
test
测试相关
test: add unit tests for login feature
build
影响构建系统或外部依赖的更改(例如:gulp,broccoli,npm)
build: update webpack config
revert
代码撤销修改
revert: revert commit 12345abc
ci
持续集成的配置文件和脚本的变动(例如:Travis,Circle,BrowserStack,SauceLabs)
ci: update Travis configuration
chore
依赖更新/脚手架配置修改等
chore: upgrade React to the latest version
perf
性能优化
perf(core): optimize virtual DOM diffing algorithm

相关推荐

文科生自学Python-生成简单的WORD文档

--天行健君子以自强不息,地势坤君子以厚德载物,学习编程成就更好的自己--Python语言简洁生动,特别适合文科生学习入门IT世界,用几十行代码就能够做一个完整的爬虫脚本,开发效率杠杠的!短时间内即可...

使用Python 爬取京东、淘宝等商品详情页的数据,避开反爬虫机制

以下是爬取京东商品详情的Python3代码,以excel存放链接的方式批量爬取。excel如下...

CV学习笔记(二十四):数据集标注与制作

最近在做一些数据标注的工作,虽然标注数据比较枯燥,但这也是每个做算法的工程师升级打怪的必由之路。使用一些合适的工具往往可以事半功倍,效率UP。一:数据标注流程二:数据处理的一些小代码1:重命名当得到这...

新手常见的python报错及解决方案(如何理解python报错信息)

此篇文章整理新手编写代码常见的一些错误,有些错误是粗心的错误,但对于新手而已,会折腾很长时间才搞定,所以在此总结下我遇到的一些问题。希望帮助到刚入门的朋友们。后续会不断补充。...

殊途同归python第5节:一键管理所有文档

Python自带的os模块,文件和文件夹的小管家,直接上代码importosa=os.getcwd()#获取当前路径,以字符串形式返回当前的绝对路径。os.chdir("动画片收...

1.文件夹的处理 OS(文件夹的操作方法)

os.getcwd()#当前目录os.listdir()#列出目录下的文件os.path.join()#拼接路径os.path.split()#拆分路径os.path.exists...

Linux下分析bin文件的10种方法(linux binary文件)

这世界有10种人,一种人懂二进制,另一种人不懂二进制。——鲁迅大家好,我是良许。二进制文件是我们几乎每天都需要打交道的文件类型,但很少人知道他们的工作原理。这里所讲的二进制文件,是指一些可执行文件,...

文科生自学Python-pandas交叉透视表降维变换

--心有猛虎,细嗅蔷薇,学习编程成就更好的自己--...

史上最全!近万字梳理Python 开发必备的 os 模块(建议收藏)

点赞、收藏、加关注,下次找我不迷路...

工作中必备的12个Git命令(常用git命令清单)

...

Undoing a git rebase(undoing a git rebase)

技术背景在使用Git进行版本控制时,gitrebase是一个强大的命令,它可以将一个分支的修改合并到另一个分支,使提交历史更加线性。然而,在某些情况下,我们可能需要撤销...

【干货】常用的Git命令有哪些?(git 常用命令行入门)

Git是一个开源的分布式版本控制系统,它被广泛用于软件开发中。在使用Git进行版本控制时,有许多常用的命令,本文将对这些命令进行详细的介绍。...

项目中使用 husky 格式化代码和校验 commit 信息

大家好,我是前端西瓜哥。今天我们学习使用husky工具,在commit的时候做一些风格的校验工作,包括commit信息格式化和文件格式化。githook和husky...

Git可视化极简易教程 — Git GUI使用方法

前言...

实际工作中 Git Commit 代码提交规范是什么样的?

...