提交规范指南 📝

遵循清晰的提交规范能显著提升团队协作效率,以下是常用规范示例:

1. 提交类型

使用 <type>(<scope>): <subject> 格式,如:

  • feat(auth): 添加登录功能
  • fix(bug): 修复页面加载错误
提交类型示例

2. 范围限定

<scope> 用于标识受影响模块,如 uiapidocs,若无则省略:

git commit -m "docs: 更新使用说明"

3. 主体描述

保持简洁,使用动词开头。例如:

  • 优化数据查询性能
  • 重构用户权限校验逻辑
代码提交示例

4. 脚注补充

添加 BREAKING CHANGEIssue: #123 等附加信息:

BREAKING CHANGE: 移除旧的API接口

扩展阅读

想要深入了解提交信息格式规范?请参考 提交信息格式指南 获取更详细的说明 📘

规范脚注示例