Git提交规范

Git 提交规范是一种约定,用于标准化提交信息,使得项目的历史记录更加清晰、易于理解和维护。这有助于团队成员快速了解每次提交的目的和影响范围。以下是一些常见的提交类型及其含义:

  1. feat (feature):

    • 含义: 表示新增了一个功能。
    • 用法示例feat: 添加用户评论功能
    • 说明: 这种类型的提交通常涉及到了业务逻辑或用户可见的新功能的增加。
  2. fix (修复):

    • 含义: 用于修复一个已知的错误或“bug”。
    • 用法示例fix: 修正支付流程中的金额计算错误
    • 说明: 当你在代码中解决了某个具体问题时使用此标签。
  3. chore:

    • 含义: 指的是那些既不是新增功能也不是修复错误的任务,通常涉及到构建过程或辅助工具的更改。
    • 用法示例chore: 更新依赖包到最新版本
    • 说明: 包括更新配置文件、脚本、构建工具或依赖项等。
  4. docs:

    • 含义: 文档更新。
    • 用法示例docs: 完善API文档注释
  5. style:

    • 含义: 代码格式调整,不影响程序逻辑。
    • 用法示例style: 统一代码缩进为4个空格
  6. refactor:

    • 含义: 代码重构,改进现有代码结构和设计,不添加新功能也不修复错误。
    • 用法示例refactor: 重写用户模块以提高性能
  7. test:

    • 含义: 添加或修改测试用例。
    • 用法示例test: 为新功能添加单元测试

这些提交信息前缀后面通常会跟着一个冒号和一个空格,然后是关于此次提交的简短描述。此外,良好的提交信息还会包含更多的细节,比如为什么要做这个改动,以及它如何解决问题或改进了什么。遵循这样的规范,可以使Git历史记录更加清晰,便于回溯和协作。


Git提交规范
https://newztx.github.io/2024/07/24/Git 提交规范/
作者
Cranky Dove
发布于
2024年7月24日
许可协议