在提交代码时,清晰的提交信息格式至关重要,它有助于团队理解和维护代码库。以下是一些关于提交信息格式的指导原则。

1. 提交信息格式

一个好的提交信息应该简洁明了,通常遵循以下格式:

<类型>(<作用域>): <描述>

1.1 类型

提交类型通常包括以下几种:

  • feat:新功能
  • fix:修复bug
  • docs:文档更新
  • style:代码格式调整
  • refactor:重构代码
  • test:测试用例
  • chore:构建过程或辅助工具的更改

1.2 作用域

作用域指的是代码变更发生的模块或文件,例如:

  • ui/
  • api/
  • models/

1.3 描述

描述应该简短明了,描述提交的目的和影响。

2. 示例

以下是一些提交信息的示例:

  • fix(api): 修复用户登录超时问题
  • feat(ui): 新增用户信息编辑功能
  • style: 格式化代码并调整代码风格

3. 链接

如需了解更多关于提交信息格式的信息,可以参考Git提交信息指南

Git提交示例