当前位置: 首页 > news >正文

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. 创建模板文件
    在项目根目录或任意位置创建一个提交模板文件,例如:
touch ~/.gitmessage.txt

将上面的内容粘贴进去并保存。
2. 设置全局 Git 配置

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

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

如果你使用 VSCode 或 IDEA 等编辑器:
VSCode 会自动打开 .gitmessage.txt 模板供你填写;
IDEA 也支持你编辑 commit message,可以手动遵守规范

http://www.lryc.cn/news/592432.html

相关文章:

  • sqli-labs靶场通关笔记:第27-28a关 union、select过滤
  • 网络安全:使用.NET 检测网络下载文件及其来源
  • pdf格式怎么提取其中一部分张页?
  • 文档处理控件TX Text Control系列教程:使用 C# .NET 将二维码添加到 PDF 文档
  • 从Hyperliquid到AILiquid:一场从极致性能到策略智能的迭代
  • Excel基础:格式化
  • HTTP性能优化实战技术文章大纲
  • LeafletJS 性能优化:处理大数据量地图
  • 深入理解 Redis 集群化看门狗机制:原理、实践与风险
  • 一文讲清楚React性能优化
  • 2025年华为认证之HCIE-云计算方向的报考流程
  • 指定阿里镜像原理
  • Stateflow Chart平替State Transition Table
  • MySQL的基本操作及相关python代码
  • 动态规划 + DFS + 记忆化!Swift 解 LeetCode 329 的实战笔记
  • 期刊论文-图片格式要求
  • 电脑视频常用几种接口
  • 深度学习入门-深度学习简介
  • 五大平台,构建AI创新转化的“同济方案”
  • 密码学基础概念详解:从古典加密到现代密码体系
  • 快速了解pycharm
  • 拓扑排序/
  • Hinge Loss(铰链损失函数)详解:SVM 中的关键损失函数
  • 银河麒麟高级服务器V10(ARM)安装人大金仓KingbaseES完整教程
  • uniapp 动态控制横屏(APP 端)
  • 创蓝闪验SDK适配uniappx版本UTS插件集成文档
  • 如何为“地方升学导向型”语校建模?Prompt 框架下的宇都宫日建工科专门学校解析(7 / 500)
  • 走进科学,走进基因突变
  • Unity 多人游戏框架学习系列四
  • AWS SSL证书无缝迁移完整指南 - 零业务中断方案