git&SVN提交规范

commit message = subject + :+ 空格 + message 主体

例如: feat:增加用户注册功能

常见的 subject 种类以及含义如下:

  1. feat: 新功能(feature)

    • 用于提交新功能。

    • 例如:feat: 增加用户注册功能

  2. fix: 修复 bug

    • 用于提交 bug 修复。

    • 例如:fix: 修复登录页面崩溃的问题

  3. docs: 文档变更

    • 用于提交仅文档相关的修改。

    • 例如:docs: 更新README文件

  4. style: 代码风格变动(不影响代码逻辑)

    • 用于提交仅格式化、标点符号、空白等不影响代码运行的变更。

    • 例如:style: 删除多余的空行

  5. refactor: 代码重构(既不是新增功能也不是修复bug的代码更改)

    • 用于提交代码重构。

    • 例如:refactor: 重构用户验证逻辑

  6. perf: 性能优化

    • 用于提交提升性能的代码修改。

    • 例如:perf: 优化图片加载速度

  7. test: 添加或修改测试

    • 用于提交测试相关的内容。

    • 例如:test: 增加用户模块的单元测试

  8. chore: 杂项(构建过程或辅助工具的变动)

    • 用于提交构建过程、辅助工具等相关的内容修改。

    • 例如:chore: 更新依赖库

  9. build: 构建系统或外部依赖项的变更

    • 用于提交影响构建系统的更改。

    • 例如:build: 升级webpack到版本5

  10. ci: 持续集成配置的变更

    • 用于提交CI配置文件和脚本的修改。

    • 例如:ci: 修改GitHub Actions配置文件

  11. revert: 回滚

    • 用于提交回滚之前的提交。

    • 例如:revert: 回滚feat: 增加用户注册功能

总结

使用规范的提交消息可以让项目更加模块化、易于维护和理解,同时也便于自动化工具(如发布工具或 Changelog 生成器)解析和处理提交记录。

通过编写符合规范的提交消息,可以让团队和协作者更好地理解项目的变更历史和版本控制,从而提高代码维护效率和质量。

相关推荐
普修罗双战士17 分钟前
高效使用 Git:从入门到精通的实战指南
java·git
摇滚侠2 小时前
创建 git 忽略文件 忽略 .obsidian 这个目录
大数据·git·elasticsearch
studytosky2 小时前
【高并发内存池】线程缓存核心原理与实现
linux·服务器·git·缓存
咕咕嘎嘎10242 小时前
问卷系统测试报告
git
水无痕simon3 小时前
04 Git基础-记录每次更新到仓
git
无限进步_4 小时前
【C++】寻找数组中出现次数超过一半的数字:三种解法深度剖析
开发语言·c++·git·算法·leetcode·github·visual studio
一个程序猿老马15 小时前
012、远程协作:连接GitHub/Gitee与git remote
git·gitee·github
Lisonseekpan19 小时前
Git:如何将一个分支的特定提交合并到另一个分支?
java·大数据·git·后端·elasticsearch
pas13620 小时前
git 配置
git
独隅1 天前
Git误操作急救手册
大数据·git·elasticsearch