Git commit 通用提交消息规范

在使用Git进行版本控制时,可以采用一种通用的提交消息规范,以提高团队协作和代码审查的效率。一种常见的提交消息规范是使用 "Conventional Commits" 规范,它使用一些预定义的关键字来标识提交的类型和目的。以下是一些常见的关键字和它们的含义:

  1. feat: 新功能(feature):表示提交引入了新的功能、功能改进或添加新的功能点。

  2. fix: 修复(fix):表示提交修复了一个Bug或解决了一个问题。

  3. refactor: 重构(refactor):表示提交对代码进行了重构,但没有添加新功能或修复Bug。

  4. docs: 文档(docs):表示提交更新了文档,例如README文件、文档注释等。

  5. style: 格式(style):表示提交对代码的格式进行了修改,如缩进、空格、格式化等,但没有改变代码的逻辑。

  6. chore: 杂务(chore):表示提交执行了与构建、工具、依赖管理等相关的杂务任务。

  7. test: 测试(test):表示提交添加或修改了测试用例。

  8. perf: 性能(perf):表示提交对代码进行了性能优化。

  9. ci: 持续集成(ci):表示提交对持续集成配置进行了修改。

  10. revert: 撤销(revert):表示提交撤销了之前的提交。

示例提交消息:

复制代码
feat: 添加用户注册功能
fix: 修复登录页面的输入验证问题
docs: 更新README文件
style: 格式化代码
chore: 更新依赖版本
test: 添加用户管理模块的单元测试
perf: 优化数据库查询性能
ci: 更新CI配置
revert: 撤销上一个提交

采用这种规范的提交消息有助于清晰地了解每个提交的目的,提高代码审查的效率,追踪项目的变更历史,以及生成有意义的版本发布日志。你可以根据团队的实际需求自定义提交消息规范,并使用工具或脚本来验证和自动化检查提交消息的格式。

相关推荐
ruanCat1 小时前
加了 .gitattributes 就万事大吉?我差点毁了整个团队的 Git 工作流
git
咋吃都不胖lyh1 小时前
查看 Git 本地仓库关联的远程仓库链接(URL)
git
wheelmouse77881 小时前
AI 时代的 Git 进阶术:如何优雅地让多个 Agent 并行开发
人工智能·git·ai编程
如意.75912 小时前
【Linux开发工具实战】Git、GDB与CGDB从入门到精通
linux·运维·git
用户91868612868717 小时前
Git 版本控制完全指南:从入门到精通
git
简离19 小时前
Git 一次性清理已跟踪但应忽略文件
前端·git
Drone_xjw19 小时前
【环境搭建】Windows 10上使用Docker搭建本地Git仓库(Gitea)完整教程
windows·git·docker
疯狂成瘾者19 小时前
git学习目录
git·学习
曾几何时`20 小时前
Git——自用手册
git
新镜1 天前
【git】 曾经合入的文件被删除,再次合入时,相同的文件路径并不会自动合入
git