在 Git 中,为了使提交历史清晰、可读且易于维护,开发者通常会在提交信息(commit message)前加上一些约定的前缀,用来说明这次提交的类型或目的。这些前缀一般遵循某种约定,比如 Conventional Commits 或团队内部标准。

以下是一些常见的 Git 提交前缀及其含义:

基于功能的前缀

  1. feat:

    • 表示新增功能(feature)。
    • 示例:feat: add user authentication module
  2. fix:

    • 表示修复 bug。
    • 示例:fix: resolve login form validation error
  3. refactor:

    • 表示代码重构,没有新增功能或修复 bug,只是优化了代码结构。
    • 示例:refactor: simplify user service logic
  4. chore:

    • 表示杂项改动,例如更新依赖、配置文件或脚本,不涉及代码逻辑改动。
    • 示例:chore: update npm dependencies
  5. style:

    • 表示代码格式修改,不影响功能(如调整空格、格式化代码)。
    • 示例:style: format code with Prettier
  6. perf:

    • 表示性能优化。
    • 示例:perf: improve query efficiency in database
  7. test:

    • 表示增加或更新测试代码。
    • 示例:test: add unit tests for user service
  8. docs:

    • 表示文档更新。
    • 示例:docs: update README with installation instructions
  9. ci:

    • 表示修改持续集成配置或脚本。
    • 示例:ci: add GitHub Actions for CI/CD pipeline
  10. build:

    • 表示构建相关的修改,例如更新打包配置。
    • 示例:build: configure webpack for production build
  11. revert:

    • 表示回滚某次提交。
    • 示例:revert: revert commit abc123

基于团队约定的前缀(可选)

  1. hotfix:

    • 表示紧急修复。
    • 示例:hotfix: fix crash issue on production
  2. wip:

    • 表示工作进行中(Work In Progress)。
    • 示例:wip: implement initial draft of dashboard
  3. merge:

    • 表示合并分支。
    • 示例:merge: merge feature/authentication into main
  4. deps:

    • 表示更新依赖项(Dependency)。
    • 示例:deps: upgrade lodash to version 4.17.21

注意事项

  • 提交信息尽量保持清晰、简洁,必要时可以在前缀后加冒号和简要描述。
  • 对于更详细的说明,可以在第一行后加入详细描述。
  • 如果团队使用了 Conventional Commits,提交信息会被规范化处理,这对生成变更日志和版本发布尤为重要。

使用标准化前缀可以大幅提升代码管理效率和团队协作体验。