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 生成器)解析和处理提交记录。

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

相关推荐
inferno18 小时前
SVN学习笔记(二)
笔记·学习·svn
挖掘狂人20 小时前
Git 从 0 到 1:用一个小项目走完 add / commit / reset / merge / rebase / push
git·后端·github
codigger21 小时前
Git 三区域模型:把 add、commit、reset、merge 一次讲透
git·github·编程·编程语言
水饺编程21 小时前
第1章:开发环境搭建,在 Windows 中安装 Git
linux·c语言·汇编·git·ubuntu
idanzk21 小时前
Git 推送 GitHub 报 SSL_READ /src refspec main 不匹配 完整踩坑记录
git·github·ssl
星恒随风1 天前
Linux开发工具详解(二):Git版本控制、GitHub协作与GDB调试实战
linux·笔记·git·学习·github
寺中人2 天前
Xshell 完全入门指南:从安装到实战,远程连接+文件传输+会话管理全拆解
git·ssh·github·php·远程连接·xshell·运维工具
酬谢神明则必安2 天前
git学习记录01
linux·git·学习
lingchen19062 天前
版本控制 Git源代码项目管理
git
虫无涯2 天前
Coverity 如何结合 GJB8114-2013使用?
git·单元测试·嵌入式测试·coverity·静态扫描