Git提交前缀

Git提交前缀包括‌:

bash 复制代码
feat‌:表示新增功能,例如添加了一个新的模块、页面或API等‌
‌fix‌:表示修复bug,即修复代码中的错误或问题‌
refactor‌:表示重构代码,优化代码结构、可读性或性能,但不添加新功能或修复bug‌
‌docs‌:表示文档更新,包括修改文档内容、添加注释等‌
‌style‌:表示代码格式调整,如调整缩进、空格等,但不改变代码功能‌
‌test‌:表示测试相关的更改,如添加或更新测试用例‌
‌chore‌:表示琐碎的任务,如更新构建工具、文档生成等
‌perf‌:表示性能优化,改进代码性能‌
‌build‌:表示构建相关的改动,如升级构建脚本或依赖项‌
‌ci‌:表示持续集成相关的更改,如添加CI配置文件等‌
‌revert‌:表示撤销之前的提交,回到之前的状态‌

1. feat (Feature)

  • 表示新增功能。
  • 示例:feat: add login functionality

2. fix (Fix)

  • 表示修复Bug。
  • 示例:fix: resolve null pointer exception

3. refactor (Refactor)

  • 表示代码重构,没有新增功能或修复Bug。
  • 示例:refactor: improve code structure in user module

4. docs (Documentation)

  • 表示更新文档,不影响代码逻辑。
  • 示例:docs: update README with installation instructions

5. style (Style)

  • 表示代码格式修改(如空格、缩进等),不影响功能。
  • 示例:style: fix indentation in main.ts

6. test (Test)

  • 表示添加或修改测试用例。
  • 示例:test: add unit tests for authentication service

7. chore (Chore)

  • 表示构建过程或辅助工具的改动。
  • 示例:chore: update dependency versions

8. perf (Performance)

  • 表示性能优化。
  • 示例:perf: optimize database query execution time

9. build (Build)

  • 表示构建系统或外部依赖的改动。
  • 示例:build: switch to new CI/CD pipeline configuration

10. ci (Continuous Integration)

  • 表示CI配置文件或脚本的改动。
  • 示例:ci: add GitHub Actions workflow for automated testing

11. revert (Revert)

  • 表示撤销之前的提交。
  • 示例:revert: undo changes introduced in commit abc123

12. merge (Merge)

  • 表示合并分支的操作。
  • 示例:merge: integrate feature branch into main

提交信息的最佳实践

  • 使用动词开头(如addremoveupdate等)。
  • 简短明了,尽量控制在50个字符以内。
  • 如果需要详细说明,可以在第一行后换行并添加更多内容。

通过这些规范化的标签,团队成员可以快速理解每次提交的主要目的和改动范围。

Changes、Fixed 和 Update,feat、fix傻傻分不清

特性 fix Fixed
风格 简洁、现代 正式、传统
大小写 小写 首字母大写
自动化支持 支持自动化工具(如Changelog生成) 不常用在自动化工具中
适用团队 遵循 Conventional Commits 的团队 更自由的团队

建议

  • 如果你的团队遵循 Conventional Commits 或需要与自动化工具集成,建议使用 fix。
  • 如果你的团队更注重自然语言描述或没有严格的提交规范,可以选择 Fixed。
  • 无论选择哪种形式,保持团队内的一致性是最重要的。
相关推荐
恋猫de小郭1 小时前
Google I/O Extended :2025 Flutter 的现状与未来
android·前端·flutter
@Ryan Ding1 小时前
MySQL主从复制与读写分离概述
android·mysql·adb
移动开发者1号2 小时前
Android 同步屏障(SyncBarrier)深度解析与应用实战
android·kotlin
移动开发者1号2 小时前
深入协程调试:协程调试工具与实战
android·kotlin
雨白10 小时前
Jetpack系列(三):Room数据库——从增删改查到数据库平滑升级
android·android jetpack
花王江不语13 小时前
android studio 配置硬件加速 haxm
android·ide·android studio
江太翁15 小时前
mediapipe流水线分析 三
android·mediapipe
与火星的孩子对话16 小时前
Unity进阶课程【六】Android、ios、Pad 终端设备打包局域网IP调试、USB调试、性能检测、控制台打印日志等、C#
android·unity·ios·c#·ip
tmacfrank17 小时前
Android 网络全栈攻略(四)—— TCPIP 协议族与 HTTPS 协议
android·网络·https
fundroid18 小时前
Kotlin 协程:Channel 与 Flow 深度对比及 Channel 使用指南
android·kotlin·协程