良好的提交信息能显著提升代码可维护性与团队协作效率。以下是核心原则:
1. 明确描述变更 📌
- 使用具体动词:如
feat
(新增)、fix
(修复)、docs
(文档) - 避免模糊词汇:如 "update" → "优化性能瓶颈"
- 示例:
❌fix bug
✅fix_login_timeout_issue
2. 保持简洁性 ✅
- 前缀遵循约定:
feat/
,fix/
,refactor/
等 - 正文补充细节:如
优化数据库查询速度,减少30%响应时间
- 示例:
✅perf: 优化图片加载逻辑
3. 遵循「50/72」规则 📐
- 前50字符:简明概括变更类型
- 后72字符:详细说明实现方式或影响范围
- 示例:
feat: 添加用户登录功能 | 实现基于JWT的认证流程
4. 增加可读性 📚
- 使用冒号分隔:
feat: 支持多语言界面
- 避免特殊符号:除非必要,否则不使用
#
或@
- 示例:
✅docs: 更新API文档,补充参数说明
🔗 了解更多提交规范
💡 提交信息是代码的「历史注解」,请认真对待每一行文字!