讲师中心 微信公众号

工具推荐

视频效率加速
立刻MV
立刻MV

低成本歌曲 MV、视频生成

updream

一键生成高质量推广成片

Seko
Seko

AI短剧一键生成成片

AniShort
AniShort

AI短剧协同制作平台

VS Code中的Git提交模板:编写规范化的Commit Message

星敏小哥_7804

星敏小哥_7804

发布时间:2025-11-27 20:47:38

|

958人浏览过

|

来源于php中文网

原创

规范化Commit Message可提升团队协作与代码可读性。1. 创建.gitmessage.txt模板文件定义格式;2. 通过git config commit.template配置路径;3. 推荐采用Conventional Commits规范:类型(作用域): 描述;4. 在VS Code中结合插件、代码片段和commitlint+husky实现自动校验,确保提交一致性,最终便于生成changelog与版本管理。

vs code中的git提交模板:编写规范化的commit message

在 VS Code 中使用 Git 提交时,编写规范化的 Commit Message 能提升团队协作效率、增强代码历史可读性,并为后续的版本管理和自动化工具(如生成 changelog)提供支持。通过配置提交模板和遵循约定格式,可以让每次提交更清晰、一致。

为什么需要 Commit Message 模板?

没有规范的提交信息容易导致:

  • 信息模糊,如“修复问题”或“更新代码”,难以理解具体变更
  • 历史记录混乱,不利于排查问题或回溯变更
  • 无法自动生成 changelog 或进行语义化版本控制

设定模板能引导开发者填写结构化内容,提高信息质量。

设置 VS Code 中的 Git 提交模板

1. 创建模板文件

在项目根目录或用户目录下创建一个文本文件,例如 .gitmessage.txt:

<font face="Consolas, 'Courier New', monospace">
# 类型(作用域): 简短描述
# 
# * feat: 新功能
# * fix: 修复缺陷
# * docs: 文档变更
# * style: 代码格式调整(不影响逻辑)
# * refactor: 重构(非新增功能或修复 bug)
# * test: 添加或修改测试
# * chore: 构建流程或辅助工具变动
<p>type(scope): subject</p><p>Body of commit message (optional)</p><ul><li>添加详细说明(可选)</li><li>列出关键变更点</li><li>关联 issue: #123
</font>

2. 配置 Git 使用该模板

Git工作流专业版
Git工作流专业版

企业级 Git 工作流方案,支持 Git Flow、团队协作、冲突工具集成与批量分支管理。

下载

在终端中运行以下命令(替换为你的模板路径):

<font face="Consolas, 'Courier New', monospace">git config commit.template ~/.gitmessage.txt</font>

也可以针对当前项目单独设置:

<font face="Consolas, 'Courier New', monospace">git config --local commit.template .gitmessage.txt</font>

配置完成后,每次在 VS Code 中打开提交输入框时,模板不会直接显示,但可通过其他方式辅助输入(见下文)。

推荐的 Commit Message 格式:Conventional Commits

采用 Conventional Commits 规范是一种广泛接受的做法。基本结构为:

<font face="Consolas, 'Courier New', monospace">类型(可选范围): 描述</font>

常见类型包括:

  • feat(api): 添加用户登录接口 —— 新增功能
  • fix(ui): 修复按钮点击无效问题 —— 修复 bug
  • refactor(auth): 优化登录状态管理逻辑 —— 重构代码
  • docs: 更新 README 安装说明 —— 文档更新

主体部分可补充细节,比如动机、影响范围;页脚可标注打破性变更或关联任务编号。

在 VS Code 中提升提交体验

虽然 VS Code 不直接预览模板内容,但可以通过以下方式增强输入体验:

  • 安装插件:如 "Git Commit Template" 或 "Better Commit Policy",可自动填充建议格式
  • 使用快捷键 + 片段:自定义用户代码片段(Snippets),快速插入标准格式
  • 结合提交前检查:使用 commitlint 和 husky 验证提交信息是否符合规范

例如,在项目中添加 commitlint 配置后,不符合格式的提交将被拒绝,确保一致性。

基本上就这些。规范化提交不是为了增加负担,而是让每一次变更都更有意义。从设置一个简单的模板开始,逐步养成好习惯,你会发现代码历史变得更清晰、更可靠。

热门AI工具

更多
二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

相关专题

更多
硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

3268

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

5569

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

3909

2025.12.29

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

506

2026.01.19

自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

7759

2023.07.05

git和svn的区别
git和svn的区别

git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。

2120

2023.07.06

git撤销提交的commit
git撤销提交的commit

Git是一个强大的版本控制系统,它提供了很多功能帮助开发人员有效地管理和控制代码的变更,本专题为大家提供git 撤销提交的commit相关的各种文章内容,供大家免费下载体验。

1274

2023.07.24

git提交错误怎么撤回
git提交错误怎么撤回

git提交错误撤回的方法:git reset head^:撤回最后一次提交,恢复到提交前状态。git revert head:创建新提交,内容与之前提交相反。git reset :使用提交的 sha-1 哈希撤回指定提交。交互式舞台区:标记要撤回的特定更改,然后提交,排除已撤回更改。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

5017

2024.04.09

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

140

2026.11.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Postman Native Git工作流指南
Postman Native Git工作流指南

共0课时 | 0人学习

vscode手册
vscode手册

共0课时 | 0人学习

Git 教程
Git 教程

共21课时 | 8.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn