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 提交模版或者写个脚本规范提交信息吗?

相关推荐
流浪00138 分钟前
Git篇(三):吃透远程协作:SSH 密钥、分支、标签全流程实战指南
运维·git·ssh
莫成18 小时前
git相关命令查阅
git
ljh5746491191 天前
git stash 和 git stash apply
git
慕容引刀1 天前
告别Commit信息纠结:使用Git AI Commit插件实现规范化提交
人工智能·git·github·visual studio code·visual studio
敲代码的嘎仔2 天前
实习日志day6--实习日志day6--title命名规范化&businessType纠正&补充缺失的@Log注解&报警与通信模块补充&产出阶段总结文档
java·开发语言·人工智能·git·python·实习·大二
刘马想放假2 天前
Git 从入门到进阶:一篇吃透版本管理的实战指南
git·gitlab
开发者联盟league2 天前
git commit报错No .pre-commit-config.yaml file was found
git
猫老板的豆2 天前
git实战
git
风曦Kisaki2 天前
# Linux实战笔记-HIS项目实战Day01:版本控制与Git基础
linux·笔记·git
鲸~屿2 天前
Git上传本地文件到GitHub教学指南
git·github