Skip to content

Commit e66041d

Browse files
See USee U
authored andcommitted
docs: state fork intent and require PLAN/MERGE review after each sync
1 parent fc5a809 commit e66041d

2 files changed

Lines changed: 29 additions & 1 deletion

File tree

MERGE.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@ opencode-x 是基于 [anomalyco/opencode](https://github.com/anomalyco/opencode)
66

77
自裁剪工程收尾后,合并进入**审计式吸收**常态:每次 sync 只提取并比对上游的新特性与问题修复,保留更新、更有用的实现;双方共改的模块通过对抗审计裁决最优实现。
88

9+
### 项目意图(合并决策的最高准绳)
10+
11+
- **只为个人 agent 终端使用而存在**:裁掉云端/sync/share/OTEL/Copilot/desktop/Web/企业化/无消费的 SDK 等一切与个人 CLI 无关的部分。上游若在这些方向上演进,一律按第 ① 类丢弃。
12+
- **只删不改架构**:不主动重构上游架构,精简聚焦;跟随上游纯重构以降低未来冲突面。
13+
- **长期跟踪上游、永不脱轨**:随上游 release 触发审计式吸收,保持可持续合并能力。
14+
- **一切偏离必须审计验证**:任何删除/保留/自有改进都以对抗审计(并排比较、基准测试)为依据,并登记到「fork 偏离清单」。
15+
- **持续打磨 TUI 到一流水准**:参照 Claude Code / Qoder / Kimi,动效克制且可关;Knight-Rider 提示扫描动画不动。
16+
- **PLAN.md 与 MERGE.md 是活文档**:随事实演进,每次 sync 后强制复核(见「sync 收尾清单」)。
17+
918
## 远程配置
1019

1120
```bash
@@ -245,4 +254,5 @@ cd packages/opencode && bun test test/cli/help
245254
- [ ] 上游已吸收的偏离条目已移除
246255
- [ ] 新拒绝的路径已加入 `merge-clean.ts` 清单与「已删包列表」
247256
- [ ] 合并后验证全部通过
257+
- [ ] **已判断 PLAN.md / MERGE.md 是否需要更新**(基线版本/sync 轨迹、新阶段/新包/新自有改进、偏离清单回写、`merge-clean.ts` 清单同步)——需更新则回写;无需更新则在 sync commit 说明中记录「PLAN/MERGE 已复核,无需更新」
248258
- [ ] commit message 标注 baseline 版本

PLAN.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,17 @@
44

55
opencode-x 是 [anomalyco/opencode](https://github.com/anomalyco/opencode) 的个人精简 fork。
66

7-
**定位与原则**
7+
### 项目意图(作者意图,一切决策的最高准绳)
8+
9+
- **只为个人 agent 的终端使用而存在**:核心价值在 CLI + TUI 的编码体验;凡与此无关的能力(云端账户 / 多设备 sync / Session share / 遥测 OTEL / GitHub Copilot / 桌面端 desktop / Web UI / 企业与控制台 / 无消费方的 SDK 层)一律裁剪。
10+
- **只删不改架构**:不主动重写上游架构,永远保持可持续跟随上游演进;偏离只应来自「删除不需要的」与「打磨已保留的」,不应来自「另起炉灶」。
11+
- **长期跟踪上游,永不脱轨**:定期 sync upstream/dev,宁可小步高频,避免攒批产生大冲突。
12+
- **一切偏离必须审计验证**:删除、保留、自有改进都要经对抗审计(并排比较、必要时基准测试)裁决,并登记在 MERGE.md 偏离清单,供下次 sync 复审。
13+
- **持续打磨 TUI 到一流水准**:以 Claude Code / Qoder / Kimi CLI 的公共优点为参照,追求最佳阅读与交互体验,但动效克制、可关闭,尊重既有约束(如 Knight-Rider 扫描动画不动)。
14+
- **PLAN.md 与 MERGE.md 是活文档**:始终反映真实状态;每次上游同步完毕后必须判断二者是否需要更新(见下方「文档同步准则」)。
15+
16+
### 定位与原则
17+
818
- **长期跟踪上游**:跟随 upstream/dev 的演进,定期同步
919
- **只删不改架构**:不主动做架构改造,精简聚焦个人 agent 使用场景
1020
- **一切偏离必须审计验证**:无论是删除、保留还是自有改进,都以对抗审计(并排比较、基准测试)为决策依据
@@ -14,6 +24,14 @@ opencode-x 是 [anomalyco/opencode](https://github.com/anomalyco/opencode) 的
1424
| upstream | `anomalyco/opencode` (`dev`) |
1525
| 本地 | `main`(基于 `upstream/dev`|
1626

27+
### 文档同步准则(每次上游更新完毕后强制执行)
28+
29+
**每完成一次上游 sync,必须判断 PLAN.md 与 MERGE.md 是否需要更新,并据判断结果更新或显式记录「无需更新」**
30+
31+
- **PLAN.md**:上游基线版本号与 sync 轨迹是否变化?是否出现新的已完成阶段 / 新保留或新删除的包 / 新的重大自有改进?
32+
- **MERGE.md**:偏离清单是否需要回写(新增对抗审计裁决、移除上游已吸收的条目、删除已消失的载体文件)?已删/保留包列表、`script/merge-clean.ts` 清单是否需同步?
33+
- 若判断确实无需改动,也应在 sync commit 说明中一句话记录「PLAN/MERGE 已复核,无需更新」,避免"忘记判断"与"判断过但没写"混淆。
34+
1735
## 当前状态
1836

1937
- **上游基线**`v1.18.7`(sync 轨迹:v1.18.2 → v1.18.4 → v1.18.6 → v1.18.7)

0 commit comments

Comments
 (0)