GitHub 提交只有 Summary(标题) 和 Description(描述) 两个部分。 请严格按照以下规范撰写 commit 消息。
<type>(<scope>)?: <subject>
[可选的详细描述]Summary(标题):
feat(auth): 新增用户登录验证码功能
Description(描述)(可选):
新增短信验证码登录方式,支持国内手机号快速验证。
修复了验证码倒计时结束后无法重新发送的问题。
Closes #123
必须使用以下其中之一(小写):
| 类型 | 含义 | 说明 |
|---|---|---|
feat |
新功能 | 新增特性或功能 |
fix |
Bug 修复 | 修复缺陷 |
docs |
文档 | 修改文档、注释、README 等 |
style |
代码格式 | 格式调整(不影响代码逻辑) |
refactor |
代码重构 | 既非新增功能也非 Bug 修复 |
perf |
性能优化 | 提升性能 |
test |
测试 | 添加或修改测试用例 |
build |
构建系统 | 修改构建配置、外部依赖等 |
ci |
持续集成 | 修改 CI/CD 配置 |
chore |
其他杂项 | 不影响生产代码的变更 |
revert |
回滚 | 撤销之前的提交 |
强制要求:Type 后面的
<subject>必须使用简体中文。
-
标题(Summary):
- 以
type开头,例如feat:、fix: - 可加作用域,如
feat(auth):、fix(login): <subject>必须使用简体中文- 首字母小写
- 不以句号
.结尾 - 控制在 50 个字符以内(推荐 ≤ 72 个字符)
- 使用祈使句:“新增”“修复”“优化”“删除”等
- 以
-
描述(Description):
- 推荐使用简体中文
- 可分行或使用列表
- 可写
Closes #123、Fixes #456等
feat(user): 新增手机号快捷登录功能fix(login): 修复验证码输入后自动提交失效的问题docs: 更新项目部署文档refactor(utils): 重构请求拦截器逻辑perf: 优化首页加载速度
修复了一个bug(缺少类型)feat: add login feature(使用英文)新增了用户登录功能。(多了“了”和句号)