提交信息结构 🧩
优秀的提交信息应包含以下要素:
- 标题:简明扼要描述变更内容 📦
示例:feat: 添加用户登录功能
- 正文(可选):详细说明实现细节或影响范围 📖
示例:修复表单验证逻辑,新增密码强度检测
- 脚注(可选):添加关联Issue或修复的编号 📌
示例:See #1234 for more context
最佳实践 ✅
- 动词开头:使用
feat
、fix
、docs
等类型前缀提交信息类型示例 - 保持简洁:标题控制在50字符以内,正文不超过100字符
- 关联资源:通过
See #xxx
或Closes #xxx
链接到相关Issue - 避免模糊词汇:如"修改"、"优化"等,应具体说明变更内容
示例展示 📚
feat: 📱 优化移动端布局响应速度
fix: 🧩 修复购物车结算逻辑错误
docs: 📖 更新API文档示例
提交信息格式示例
扩展阅读 🔍
如需深入了解提交规范,可参考:
提交信息约定指南
分支策略最佳实践
提交信息是代码历史的重要记录,清晰的描述能显著提升团队协作效率 🚀