Git语义化提交规范及提交模板设置

Git语义化提交规范(Conventional Commits)

📚 常见的语义化提交类型包括:

类型 含义说明
feat ✨ 新增功能(feature)
fix 🐛 修复 bug
docs 📚 修改文档(如 README)
style 💄 格式调整,不影响代码逻辑(如缩进)
refactor 🔨 代码重构,非功能性修改
test ✅ 增加或修改测试代码
chore 🔧 构建过程或辅助工具的变动
perf ⚡ 性能优化
ci 🤖 持续集成相关配置或脚本

✅ 示例:

复制代码
git commit -m "feat: 新增用户登录接口"
git commit -m "fix: 修复登录失败后页面未跳转的问题"

Git 提交模板(commit message template)

你可以配置到你的 Git 项目中,帮助你规范化每次提交的说明。

✅ Git 提交模板内容(.gitmessage.txt)

复制代码
# 请填写有意义的提交说明(英文或中文均可)
# 提交类型请参考下面的说明,在冒号后加空格书写内容

# feat:     ✨ 新功能(feature)
# fix:      🐛 修复 bug(bug fix)
# docs:     📚 文档变更(仅修改文档,不修改代码)
# style:    💄 代码格式(不影响功能,例如空格、缩进)
# refactor: 🔨 代码重构(既不是新增功能,也不是修 bug)
# perf:     ⚡ 性能优化(提高代码运行效率)
# test:     ✅ 添加或修改测试代码
# chore:    🔧 构建工具、依赖库、脚本等变更
# ci:       🤖 CI/CD 配置变更

# 示例:
# feat: 增加登录功能
# fix: 修复登录失败后页面未跳转的问题

<type>: <简短描述>

# 空一行后可以填写详细描述(可选)
# - 修改动机
# - 实现思路
# - 注意事项

# -----------------------
# 注意:提交说明第一行不要超过 100 个字符

🛠 如何使用这个模板?

  1. 创建模板文件
    在项目根目录或任意位置创建一个提交模板文件,例如:
bash 复制代码
touch ~/.gitmessage.txt

将上面的内容粘贴进去并保存。

  1. 设置全局 Git 配置

    git config --global commit.template ~/.gitmessage.txt

设置后每次你运行 git commit(不加 -m)时,编辑器会打开这个模板,方便你填写规范的提交说明。

如果你使用 VSCode 或 IDEA 等编辑器:

VSCode 会自动打开 .gitmessage.txt 模板供你填写;

IDEA 也支持你编辑 commit message,可以手动遵守规范

相关推荐
OsDepK20 小时前
项目快速Git至仓库(完整版)
大数据·git·elasticsearch·搜索引擎
妙码生花1 天前
使用git更新ai-go-admin框架
前端·人工智能·git·golang·typescript·php
朝阳5811 天前
如何用 AI 自动生成规范的 Git 提交信息:从暂存区 diff 到 Conventional Commit
人工智能·git
hudawei9961 天前
有未保存的修改,不能切换分支
git·git stash·stash
康一夏1 天前
Git Commit 规范实践:Angular Commit 规范 + Commitlint 自动化验证
git·自动化·commit msg·commit规范
LayZhangStrive1 天前
Git - 使用IDEA和git上传本地项目到Gitee远程仓库
git·gitee·idea
云泽8081 天前
Git 版本控制系统(上):架构原理与操作入门
linux·git·架构
绝世唐门三哥1 天前
Git - git stash 语法演进与实战指南
前端·git
梨想橙汁1 天前
Git 分支详解:创建切换、合并分支、冲突解决实战
前端·git
那年窗外下的雪.2 天前
AIDC 学习日志|第 21 天|EVPN 多归属故障演练与中断窗口定位
网络·git·学习