Skip to content

Commit 4e05b76

Browse files
committed
docs: 明确 dev 仅作为 issue 分支基线,不参与交付
issue 完成后只推送特性分支,提交、推送与 issue 关联均基于该分支;是否合并 dev 由人工决定,任务完成仅提示分支与 PR 链接。
1 parent 29718f6 commit 4e05b76

2 files changed

Lines changed: 9 additions & 6 deletions

File tree

‎AGENTS.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,9 @@ cd flow-engine-example && mvn spring-boot:run
106106

107107
1. **定位阶段**可只读代码分析,不必创建 worktree;
108108
2. **定位完成后先回复 issue**,说明根因与处理方案;
109-
3. **实际改代码必须使用 git worktree + 特性分支**(基于 `dev`),不得在主工作区直接修改;
109+
3. **实际改代码必须使用 git worktree + 特性分支**(worktree 仅以 `dev` 代码为基线),不得在主工作区直接修改;
110110
4. 修复需测试先行并完成本地编译/测试验证;
111-
5. 完成后**只推送该 issue 的特性分支到 GitHub**,不合并 `dev`、不推送 `dev` / `main`,`dev` 由维护者评审后合并;
111+
5. 完成后**只推送该 issue 的特性分支到 GitHub**:提交内容、推送与 issue 关联均以该特性分支为准,**不合并 `dev`**;是否合并 `dev` 由人工决定,任务完成时仅提示分支与 PR 链接;
112112
6. 提交信息使用 `Closes #<issue编号>` 关联 issue;进入默认分支后自动关闭,未自动关闭时需用户确认后手动关闭;
113113
7. **特性分支推送到 GitHub 后再回复 issue**,说明修复内容、验证结果与推送分支/提交;未推送前不得发布完成回复(定位回复不受此限)。
114114

‎docs/conventions/workflow/github-issue.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ source: 项目自有
2424

2525
1. **分析可以不开 worktree,改代码必须开**:定位阶段只读代码即可;一旦确定要修改,必须新建 git worktree + 特性分支。
2626
2. **先回复,再动手**:定位到问题后,先在对应 issue 回复根因与处理方案。
27-
3. **基于 dev 开分支,不直接合并 dev**:每个 issue 都从 `dev` 新建独立特性分支;完成后只把特性分支推送到 GitHub,由维护者评审后合并到 `dev`。助手不得自行合并 `dev`,也不得向 `dev` / `main` 推送。
27+
3. **dev 只作为基线,不参与交付**:worktree 基于 `dev` 代码创建;修复提交、推送与 issue 关联全部发生在该 issue 的特性分支上。完成后**不合并 `dev`**,是否合并由人工决定,助手只在任务完成时提示分支与 PR 链接。
2828
4. **提交即关联 issue**:提交信息使用 `Closes #<id>` 关联;是否已真正关闭取决于是否进入默认分支,未自动关闭时由维护者确认后手动关闭。
2929
5. **推送后再回复**:特性分支推送到 GitHub 之后,才在 issue 回复修复内容、提交与验证结果;**未推送前不得发布完成回复**。
3030

@@ -76,21 +76,24 @@ pnpm install --frozen-lockfile --prefer-offline # worktree 无 node_modules
7676

7777
命名约定:`feature/issue-<issue编号>-<简短英文描述>`。
7878

79+
> worktree 仅以 `dev` 代码为**基线**;创建之后的所有提交、推送与 issue 关联都只发生在该特性分支上,`dev` 不参与交付。
80+
7981
### 5. 修复与验证(TDD)
8082

8183
- 先补测试(红灯),再实现(绿灯),最后重构;
8284
- 前端:`npx rstest run`(单包)、`pnpm run test:<package>`、`pnpm run build:<package>`;
8385
- 后端:`./mvnw -pl <module> test`,必要时 `./mvnw clean install`;
8486
- **修改代码后必须本地编译/测试通过**,失败项如实报告,不得声称已验证。
8587

86-
### 6. 推送特性分支到 GitHub(不合并 dev)
88+
### 6. 推送特性分支到 GitHub(任务到此结束)
8789

8890
```bash
8991
git push -u origin feature/issue-<id>-<slug>
9092
```
9193

92-
- 只推送该 issue 的特性分支,`dev` 保持不动,由维护者评审后合并;
94+
- 只推送该 issue 的特性分支,`dev` 保持不动,是否合并由人工决定;
9395
- 禁止推送到 `dev` / `main`,禁止在本地合并 `dev`;
96+
- 任务完成提示中给出分支地址与 PR 链接即可,不代为合并;
9497
- 前后端均有改动时,两个仓库各自推送自己的特性分支;
9598
- 不更新主仓库记录的 `flow-frontend` 子模块指针,除非维护者明确要求;
9699
- 推送后可清理本地 worktree(`git worktree remove <path>`),分支保留。
@@ -125,7 +128,7 @@ Closes #<id>
125128

126129
## 禁止事项
127130

128-
- 不得向 `dev` / `main` 推送,不得在本地合并 `dev`(合并由维护者评审完成);
131+
- 不得向 `dev` / `main` 推送,不得在本地合并 `dev`(是否合并由人工决定);
129132
- 特性分支推送是标准步骤,但推送前必须确认远程分支名,避免误推;
130133
- 不得在主工作区(非 worktree)直接修改业务代码;
131134
- 不得跳过测试与编译验证;

0 commit comments

Comments
 (0)