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

提交信息的最佳实践

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

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

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

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

建议

  • 如果你的团队遵循 Conventional Commits 或需要与自动化工具集成,建议使用 fix。
  • 如果你的团队更注重自然语言描述或没有严格的提交规范,可以选择 Fixed。
  • 无论选择哪种形式,保持团队内的一致性是最重要的。
相关推荐
千里马学框架4 天前
一起学 Android 14:ShellTransition 屏幕旋转过程深度剖析
android·智能手机·性能优化·framework·性能·屏幕旋转·rotation
美狐美颜SDK开放平台4 天前
开发直播APP时如何接入视频美颜SDK?开发流程与注意事项
android·人工智能·计算机视觉·音视频·直播美颜sdk
AFinalStone4 天前
Android7 SystemUI源码解析(七)Keyguard锁屏模块深度解析
android·systemui
致远ccc4 天前
Google Play 上架前如何测试 App?多国家 Android 环境测试
android·app测试·googleplay·多国家应用测试
ttyyttemo4 天前
Kotlin 协程中的 Job 结构化并发与取消
android
sun0077004 天前
tbox 4g/5g切换,导致wan ip 改变,导致车机旧网络不可用。需要重启车机才行
android
其实防守也摸鱼5 天前
内网穿透与反向代理:原理、工具与实战指南
android·大数据·运维·安全·网络安全·自动化·渗透
AFinalStone5 天前
Android7 SystemUI 源码解析(四)NavigationBar 导航栏与 SystemBars
android·systemui
JMchen5 天前
属性动画原理与高级动画实现
android·kotlin·canvas
AFinalStone5 天前
Android7 SystemUI 源码解析(二)启动流程深度解析
android·systemui