提交信息助手
格式
遵循 Conventional Commits 规范:
<类型>(<可选范围>): <描述>
[可选正文:解释 WHY,而非 WHAT]
类型
| 类型 | 用途 |
|---|---|
feat | 新功能 |
fix | 修复 bug |
docs | 仅文档改动 |
style | 格式调整,无逻辑变化 |
refactor | 代码重构,无新功能或修复 |
test | 添加或更新测试 |
chore | 维护工作(依赖、配置) |
规则
- 主题行:最多 72 字符,使用祈使语气(“add” 而非 “added”)
- 范围可选但推荐(例如
auth、api、ui) - 正文解释 why,而非 what(diff 会展示 what)
- 每个提交只包含一个逻辑变更
工作流程
- 运行
git diff --staged查看暂存更改 - 确定主要类型和范围
- 草拟提交信息
- 验证:主题 ≤ 72 字符、祈使语气、若逻辑非明显则解释 why
示例
功能: feat(auth): 添加 JWT 令牌刷新端点
防止用户在长时间会话期间被登出
Bug 修复: fix(reports): 修正时区转换中的日期格式化
时间戳以本地时间显示,而非 UTC
文档: docs: 在 README 中添加设置说明