Skip to content

Commit 29718f6

Browse files
committed
docs: issue 流程改为推送特性分支,不合并 dev
每个 issue 从 dev 新建特性分支,完成后仅推送特性分支到 GitHub,由维护者评审合并 dev;完成回复仍以推送为前提。
1 parent 0504fbf commit 29718f6

3 files changed

Lines changed: 23 additions & 23 deletions

File tree

‎AGENTS.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,9 @@ cd flow-engine-example && mvn spring-boot:run
108108
2. **定位完成后先回复 issue**,说明根因与处理方案;
109109
3. **实际改代码必须使用 git worktree + 特性分支**(基于 `dev`),不得在主工作区直接修改;
110110
4. 修复需测试先行并完成本地编译/测试验证;
111-
5. 完成后**只合并到 `dev` 分支,不执行 `git push`**,是否推送到 GitHub 由用户决定;
111+
5. 完成后**只推送该 issue 的特性分支到 GitHub**,不合并 `dev`、不推送 `dev` / `main`,`dev` 由维护者评审后合并;
112112
6. 提交信息使用 `Closes #<issue编号>` 关联 issue;进入默认分支后自动关闭,未自动关闭时需用户确认后手动关闭;
113-
7. **代码推送到 GitHub 后再回复 issue**,说明修复内容、验证结果与合入分支;未推送前不得发布完成回复(定位回复不受此限)。
113+
7. **特性分支推送到 GitHub 后再回复 issue**,说明修复内容、验证结果与推送分支/提交;未推送前不得发布完成回复(定位回复不受此限)。
114114

115115
### 基本规范
116116

‎docs/conventions/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
| 名称 | 模块 | 描述 | 范围 | 来源 |
88
|------|------|------|------|------|
9-
| [workflow/github-issue](./workflow/github-issue.md) | workflow | GitHub Issue 标准处理流程 — 定位分析 → 回复 issue → worktree 修复 → 合并 dev → 提交关闭 → 推送 GitHub → 推送后回复 | 通用 | 项目自有 |
9+
| [workflow/github-issue](./workflow/github-issue.md) | workflow | GitHub Issue 标准处理流程 — 定位分析 → 回复 issue → worktree 修复 → 推送特性分支 → 推送后回复 | 通用 | 项目自有 |
1010

1111
---
1212

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

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: workflow/github-issue
33
module: workflow
4-
description: GitHub Issue 标准处理流程 — 定位分析 → 回复 issue → worktree 修复 → 合并 dev → 提交关闭 → 推送 GitHub → 推送后回复
4+
description: GitHub Issue 标准处理流程 — 定位分析 → 回复 issue → worktree 修复 → 推送特性分支 → 推送后回复
55
status: 已实现
66
scope: 通用
77
source: 项目自有
@@ -24,9 +24,9 @@ source: 项目自有
2424

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

3131
## 标准步骤
3232

@@ -50,7 +50,7 @@ gh issue view <id> --repo codingapi/flow-engine \
5050
- 问题原因(引用具体类/文件/方法);
5151
- 影响范围(哪些动作、端、版本);
5252
- 处理方案(改动点、交互变化、兼容性);
53-
- 交付方式(分支名、合并目标 `dev`)。
53+
- 交付方式(基于 `dev` 的特性分支名,完成后由维护者合并)。
5454

5555
```bash
5656
gh issue comment <id> --repo codingapi/flow-engine --body-file /tmp/issue-<id>-analysis.md
@@ -83,17 +83,17 @@ pnpm install --frozen-lockfile --prefer-offline # worktree 无 node_modules
8383
- 后端:`./mvnw -pl <module> test`,必要时 `./mvnw clean install`;
8484
- **修改代码后必须本地编译/测试通过**,失败项如实报告,不得声称已验证。
8585

86-
### 6. 合并到 dev(不推送)
86+
### 6. 推送特性分支到 GitHub(不合并 dev)
8787

8888
```bash
89-
git checkout dev
90-
git merge --no-ff feature/issue-<id>-<slug>
91-
# 不执行 git push,由维护者决定
89+
git push -u origin feature/issue-<id>-<slug>
9290
```
9391

94-
- 合并后保留或清理 worktree(`git worktree remove <path>`);
95-
- 若前后端均有改动,两个仓库分别合并到各自 `dev`;
96-
- 不更新主仓库记录的 `flow-frontend` 子模块指针,除非维护者明确要求。
92+
- 只推送该 issue 的特性分支,`dev` 保持不动,由维护者评审后合并;
93+
- 禁止推送到 `dev` / `main`,禁止在本地合并 `dev`;
94+
- 前后端均有改动时,两个仓库各自推送自己的特性分支;
95+
- 不更新主仓库记录的 `flow-frontend` 子模块指针,除非维护者明确要求;
96+
- 推送后可清理本地 worktree(`git worktree remove <path>`),分支保留。
9797

9898
### 7. 提交信息与 issue 关闭
9999

@@ -108,28 +108,29 @@ Closes #<id>
108108
```
109109

110110
- `Closes #<id>` 只在提交进入**默认分支**(`main`)时由 GitHub 自动关闭;
111-
- 若先合入 `dev` 且尚未发布到 `main`,issue 保持打开,待 `dev → main` 合并时自动关闭;
111+
- 推送到特性分支不会关闭 issue;特性分支合并到 `dev` 后仍保持打开,待 `dev → main` 合并时自动关闭;
112112
- 如需提前关闭,必须由维护者确认后执行 `gh issue close <id>`,不得擅自关闭。
113113

114-
### 8. 推送 GitHub 后回复 issue
114+
### 8. 推送后回复 issue
115115

116-
**前置条件:代码已推送到 GitHub**(`dev` 或其他目标分支)。推送由维护者执行或明确授权,助手不得自行推送;未推送前只可说明「修复已在本地 `dev` 完成,待推送」,不得发布完成结论。
116+
**前置条件:特性分支已推送到 GitHub**。未推送前只可说明「修复已提交到本地特性分支,待推送」,不得发布完成结论。
117117

118118
回复内容包含:
119119

120120
- 根因与最终方案(与步骤 3 的差异);
121121
- 变更文件/能力(新增公共 API、交互变化);
122122
- 验证结果(测试用例数、构建结果);
123-
- 合入分支与提交号;
123+
- 推送分支与提交号、对应 PR/评审状态;
124124
- 升级/兼容提示(如有行为变更)。
125125

126126
## 禁止事项
127127

128-
- 未经用户明确要求,不得执行 `git push` / 直接向 `main` 提交;
128+
- 不得向 `dev` / `main` 推送,不得在本地合并 `dev`(合并由维护者评审完成);
129+
- 特性分支推送是标准步骤,但推送前必须确认远程分支名,避免误推;
129130
- 不得在主工作区(非 worktree)直接修改业务代码;
130131
- 不得跳过测试与编译验证;
131-
- 不得在代码推送到 GitHub 前发布完成回复(定位回复不受此限);
132-
- 不得在代码未合入前擅自关闭 issue;
132+
- 不得在特性分支推送前发布完成回复(定位回复不受此限);
133+
- 不得在代码未进入默认分支前擅自关闭 issue;
133134
- 不得用相对路径跨 package 引用(前端规范)。
134135

135136
## 检查清单
@@ -138,7 +139,6 @@ Closes #<id>
138139
- [ ] 定位结论已在 issue 回复
139140
- [ ] worktree + 特性分支已创建(基于 `dev`)
140141
- [ ] 测试先行且全量通过,构建通过
141-
- [ ] 已合并到 `dev`(未推送)
142+
- [ ] 特性分支已推送到 GitHub(`dev` 未改动)
142143
- [ ] 提交信息包含 `Closes #<id>`
143-
- [ ] 代码已推送到 GitHub(维护者执行或确认授权)
144144
- [ ] 推送后已在 issue 回复修复与验证结果

0 commit comments

Comments
 (0)