文章

git commit message 规范

git commit message 规范

格式

1
<type>(<scope>): <subject>

type(必填)

  • feat:新功能
  • fix:直接修复 bug(自动生成 diff)
  • to:非直接修复(需多次提交)
  • docs:文档修改
  • style:格式调整(不影响代码逻辑)
  • refactor:重构(非新增功能或修复 bug)
  • 其他:如perf(性能优化)、test(新增测试)等。

scope(可选):说明影响范围(如 “DAO”“Controller”),可填*表示多范围。

subject(必填):简短描述(中文,不超过 50 字,句末无标点)。

示例

  • fix(DAO): 用户查询缺少username属性
  • feat(Controller): 用户查询接口开发
本文由作者按照 CC BY 4.0 进行授权