git 版本提交规范

Git 提交规范(Git Commit Message Convention)是为了让项目的提交历史更加清晰、可读、便于追踪和自动化工具解析。常见的规范之一是 Conventional Commits,下面是一个推荐的格式规范:


🌟 提交信息格式(Conventional Commits)

复制代码
<type>(<scope>): <subject>
  • type:提交类型,必填。
  • scope:影响范围(模块、功能、文件名等),可选。
  • subject:简洁的描述(不超过 50 字符),必填,首字母小写,结尾不加句号。

✅ 常用类型(type)

类型 描述
feat ✨ 新功能、新特性
fix 🐛 修复 bug
docs 📝 文档修改
style 💄 格式(空格、分号等,不影响逻辑)
refactor 🔨 重构(即不是新功能也不是修复)
perf ⚡ 性能优化
test ✅ 增加测试
chore 🔧 构建过程或辅助工具的变动
revert ⏪ 回退到上一个版本
ci 🤖 CI/CD 配置
build 🏗️ 构建系统或依赖变动

✍️ 示例

复制代码
feat(login): 添加用户登录功能

fix(api): 修复 getUser 接口返回 500 的问题

docs(readme): 更新项目启动说明

style: 调整缩进为 4 空格

refactor(auth): 优化权限检查逻辑

test: 增加 login 模块单元测试

chore: 更新 eslint 规则配置

💡 推荐约定

  1. 原子性:每次提交只做一件事。
  2. 简洁明了subject 不要写太长,描述清楚本次变更做了什么。
  3. 英文 vs 中文:团队内部可统一用中文或英文,但建议保持一致。

需要我帮你自动生成 Git 提交模版或者写个脚本规范提交信息吗?

相关推荐
墨白曦煜19 小时前
穿透 IDE 的障眼法:Git 四大工作区与核心数据流转解析
ide·git
idealzouhu21 小时前
深入 Git 账户模型:从提交身份到 SSH 多账户隔离的完整实践
git·ssh
是2的10次方啊21 小时前
误推 master 该 revert 还是 reset?撤销与补 MR 流程
git
菠萝加点糖1 天前
Git 删除远程文件、本地保留并取消跟踪
git
理智.6292 天前
Git 工具使用之项目版本回退与修改备份:stash、reset、reflog 常用指令详解
git·gitee·github
妙码生花2 天前
GIT 提交规范
git
云雀衔光2 天前
多个 MCP Server 怎么编排:数据库 / Redis / Git / 飞书一把梭
java·数据库·人工智能·redis·git·语言模型·飞书
Java后端的Ai之路2 天前
Git pull弹出vim编辑器完整排查指南
开发语言·人工智能·git·编辑器·vim
云泽8082 天前
Git 版本控制系统(下):从 .git 目录结构到冲突解决机制详解
大数据·git·elasticsearch
麻辣布丁3 天前
Git冲突原因与解决方法全解
大数据·git·elasticsearch