dispatch_templates 向项目种入 AGENTS.md/lefthook.yml/git-workflow.md 标准模板(蓝本取自 enterprise-system,已通用化),不存在才写、绝不覆盖用户已有;apply_onboarding_pack 组合模板分发 + apply_blueprint_buff 返回 OnboardingReport。含 3 内嵌模板 + 不覆盖单测 + commands.ts 封装。前端 UI 待接。
64 lines
1.7 KiB
Cheetah
64 lines
1.7 KiB
Cheetah
# Git 工作流 — AI Agent 操作指南
|
||
|
||
> 把此文件粘贴给任何 AI Agent,让它了解本项目的 git 工作方式。由炼境接入包分发。
|
||
|
||
## 分支策略
|
||
|
||
```
|
||
dev ← 日常开发在这里 commit/push
|
||
↓
|
||
main ← 稳定分支,通过 PR 合入(合入时触发 CI code review)
|
||
```
|
||
|
||
- 小改动可直接 push `dev`
|
||
- 功能完整后开 PR(dev → main)
|
||
- 不要直接 push `main`,除非紧急热修复
|
||
|
||
## Commit 规范(lefthook 强制)
|
||
|
||
格式:`<type>(<scope>): <描述>`
|
||
|
||
| type | 用途 |
|
||
|------|------|
|
||
| `feat` | 新功能 |
|
||
| `fix` | Bug 修复 |
|
||
| `chore` | 配置、依赖、脚本 |
|
||
| `docs` | 文档 |
|
||
| `refactor` | 重构(不改功能) |
|
||
| `ci` | CI 配置 |
|
||
| `perf` | 性能优化 |
|
||
| `style` | 代码格式 |
|
||
| `test` | 测试 |
|
||
|
||
`scope` 用「模块/子模块」二级结构(如 `auth/login`、`api/user`、`db/order`),对应项目功能模块。
|
||
|
||
```bash
|
||
git commit -m "feat(auth/login): 新增手机号登录"
|
||
git commit -m "fix(api/user): 修正分页 off-by-one"
|
||
```
|
||
|
||
> 炼境会解析这些 commit 的 type/scope 作为飞轮数据:`fix` 计入返工率、`scope` 归到模块。
|
||
> **commit 写得越规范,飞轮数据越准。**
|
||
|
||
## 一个 commit = 一件独立的事
|
||
|
||
不要 `git add -A` 一次提交所有。按功能分批:
|
||
|
||
```bash
|
||
git add <相关文件>
|
||
git commit -m "feat(模块): 一件事"
|
||
```
|
||
|
||
## PR 大小控制
|
||
|
||
PR 别攒太大(建议每 3~5 个 commit 或几百行内就开一次),否则 CI code review 易超时失效。
|
||
「所有检测通过」≠ 代码被审查过——大 PR 即使 CI 全绿,review 可能已静默失效。
|
||
|
||
## 常用命令
|
||
|
||
```bash
|
||
git status --short
|
||
git log --oneline -10
|
||
git reset --soft HEAD~1 # 撤销最后一次 commit(保留改动)
|
||
```
|