阅读全文

⭐⭐⭐ Spring Boot 项目实战	⭐⭐⭐ Spring Cloud 项目实战
《Dubbo 实现原理与源码解析 —— 精品合集》	《Netty 实现原理与源码解析 —— 精品合集》
《Spring 实现原理与源码解析 —— 精品合集》	《MyBatis 实现原理与源码解析 —— 精品合集》
《Spring MVC 实现原理与源码解析 —— 精品合集》	《数据库实体设计合集》
《Spring Boot 实现原理与源码解析 —— 精品合集》	《Java 面试题 + Java 学习指南》

摘要: 原创出处 juejin.cn/post/7374295163625521161 「JacksonChen」欢迎转载，保留摘要，谢谢！

• 写在前面
• git 提交规范
• 总结

---

🙂🙂🙂关注微信公众号：【芋道源码】有福利：

1. RocketMQ / MyCAT / Sharding-JDBC 所有源码分析文章列表
2. RocketMQ / MyCAT / Sharding-JDBC 中文注释源码 GitHub 地址
3. 您对于源码的疑问每条留言都将得到认真回复。甚至不知道如何读源码也可以请教噢。
4. 新的源码解析文章实时收到通知。每周更新一篇左右。
5. 认真的源码交流微信群。

---

写在前面

经常看到别人提交的代码记录里面包含一些feat、fix、chore等等，而我在提交时也不会区分什么，直接写下提交信息，今天就来看一下怎么个事，就拿 element-plus/ant-design 来看一下。

其实这么写是一种代码提交规范，当然不是为了炫技，主要目的是为了提高提交记录的可读性和自动化处理能力。

当然如果团队没有要求，不这么写也可以。

git 提交规范

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

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