62 lines
1.6 KiB
Markdown
62 lines
1.6 KiB
Markdown
# 提交规范
|
||
|
||
## 语义化前缀
|
||
|
||
| 前缀 | 说明 | 示例 |
|
||
|------|------|------|
|
||
| `feat:` | 新功能 | feat(menu): 添加收银系统菜单 |
|
||
| `fix:` | 修复问题 | fix(order): 修复订单计算错误 |
|
||
| `docs:` | 文档更新 | docs: 更新 README |
|
||
| `chore:` | 杂项 | chore: 更新依赖版本 |
|
||
| `test:` | 测试相关 | test: 添加单元测试 |
|
||
| `refactor:` | 重构 | refactor: 优化查询逻辑 |
|
||
|
||
## 提交信息格式
|
||
|
||
```
|
||
<type>(<scope>): <subject>
|
||
|
||
<body>
|
||
|
||
<footer>
|
||
```
|
||
|
||
## 关联工单
|
||
|
||
在提交信息中关联工单：
|
||
```
|
||
feat(menu): 添加收银系统菜单配置
|
||
|
||
- 新增 cashier.json 菜单配置文件
|
||
- 包含6个子菜单
|
||
|
||
对应工单 #2
|
||
```
|
||
|
||
## 提交频率
|
||
|
||
- **每次修改后必须提交**：AI 完成任何代码/文档修改后，必须立即执行 `git commit`
|
||
- **禁止积攒**：不允许将多次修改积攒到一起提交
|
||
- **提交时机**：每完成一个逻辑单元（如一个方法、一个文件、一个功能点）即提交
|
||
|
||
## 推送规则
|
||
|
||
| 场景 | 行为 |
|
||
|------|------|
|
||
| **常规开发** | 修改后自动 `git commit`，**不自动推送** |
|
||
| **手动推送** | 开发者可随时执行 `git push` 推送 |
|
||
| **自动推送阈值** | 当未推送提交数 **超过 10 个** 时，自动推送到远程 |
|
||
```bash
|
||
# 手动推送命令
|
||
git push origin main
|
||
```
|
||
|
||
### 检查未推送提交数
|
||
|
||
```bash
|
||
# 查看未推送的提交数量
|
||
git log origin/main..HEAD --oneline | wc -l
|
||
```
|
||
|
||
> ⚠️ **注意**：业务模块使用独立 Git 仓库，禁止将代码提交到框架主仓库（`app/` 已加入 `.gitignore`）
|