1.8 KiB
1.8 KiB
alwaysApply, scene
| alwaysApply | scene |
|---|---|
| true | git_message |
Git 提交信息规范
格式要求
提交信息必须遵循以下格式：
<type>(<scope>): <subject>
<body>
<footer>
type（类型）
使用以下类型之一：
| 类型 | 说明 |
|---|---|
feat |
新功能 |
fix |
修复缺陷 |
update |
功能更新/增强 |
refactor |
代码重构（不改变功能） |
style |
代码格式调整（不影响功能） |
docs |
文档变更 |
test |
测试相关 |
chore |
构建、依赖、配置变更 |
perf |
性能优化 |
deploy |
部署相关变更 |
scope（作用域）
可选，标明影响范围。本项目常用作用域：
admin- 后台模块front- 前台模块common- 公共模块api- API接口plugin- 插件config- 配置database- 数据库/SQLui- 界面样式security- 安全相关
subject（主题）
- 使用中文描述
- 简洁明了，不超过 50 字
- 以动词开头：新增、修复、优化、删除、修改、更新等
- 句末不加标点
body（正文）
可选，详细说明变更内容：
- 列出具体变更点
- 每行以
-开头 - 说明变更原因（如有必要）
footer（页脚）
可选，用于：
- 关联 Issue：
Refs: #123 - 破坏性变更说明
- 备注信息
示例
feat(admin): 新增订单导出功能
- 新增订单列表页导出按钮
- 支持导出当前筛选结果
- 导出字段包含订单号、金额、状态、下单时间
fix(front): 修复会员中心头像上传失败问题
- 修复 multipart 表单 boundary 生成错误
规则
- 提交信息使用中文
- type 和 subject 必填，scope 和 body 可选
- 空行分隔 subject 和 body
- 保持简洁，避免冗长描述