refactor: 精简 CLAUDE.md + 分层上下文管理
根 CLAUDE.md 从 80 行压缩到 15 行，详细规则拆分到按需加载位置： - .claude/rules/development.md — 开发规则、测试要求、commit 规范 - .claude/rules/release.md — 发版流程、纪律、Release Notes 格式、构建说明 - docs/CLAUDE.md — docs 目录导航，要求检索前先读子目录 README - src/lib/bridge/CLAUDE.md — bridge 模块关键约定（runAdapterLoop 时序、 bridgeModeActive 互斥、offset 安全水位、adapter 扩展方式） 目的：减少每次会话的固定上下文消耗，非相关模块的文档不加载到上下文。 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
7418andClaude Opus 4.6 committed
1 parent
d9c4ad2c95
commit
ead5cfcf8b
5 files changed
+54
-66
No files matched your search
@@ -0,0 +1,19 @@
|
||||
## Development Rules
|
||||
|
||||
**提交前必须详尽测试：**
|
||||
- 每次提交代码前，必须在开发环境中充分测试所有改动的功能，确认无回归
|
||||
- 涉及前端 UI 的改动需要实际启动应用验证（`npm run dev` 或 `npm run electron:dev`）
|
||||
- 涉及构建/打包的改动需要完整执行一次打包流程验证产物可用
|
||||
- 涉及多平台的改动需要考虑各平台的差异性
|
||||
|
||||
**新增功能前必须详尽调研：**
|
||||
- 新增功能前必须充分调研相关技术方案、API 兼容性、社区最佳实践
|
||||
- 涉及 Electron API 需确认目标版本支持情况
|
||||
- 涉及第三方库需确认与现有依赖的兼容性
|
||||
- 涉及 Claude Code SDK 需确认 SDK 实际支持的功能和调用方式
|
||||
- 对不确定的技术点先做 POC 验证，不要直接在主代码中试错
|
||||
|
||||
**Commit 信息规范：**
|
||||
- 标题行使用 conventional commits 格式（feat/fix/refactor/chore 等）
|
||||
- body 中按文件或功能分组，说明改了什么、为什么改、影响范围
|
||||
- 修复 bug 需说明根因；架构决策需简要说明理由
|
||||
@@ -0,0 +1,13 @@
|
||||
## Release
|
||||
|
||||
**发版流程：** 更新 package.json version → `npm install` 同步 lock → 提交推送 → `git tag v{版本号} && git push origin v{版本号}` → CI 自动构建发布。不要手动创建 GitHub Release。
|
||||
|
||||
**发版纪律：** 禁止自动发版。`git push` + `git tag` 必须等用户明确指示后才执行。commit 可以正常进行。
|
||||
|
||||
**Release Notes 格式：** 标题 `CodePilot v{版本号}`，正文包含：更新内容、Downloads、Installation、Requirements、Changelog。
|
||||
|
||||
## Build Notes
|
||||
|
||||
- macOS 产出 DMG（arm64 + x64），Windows 产出 NSIS 安装包或 zip
|
||||
- `scripts/after-pack.js` 重编译 better-sqlite3 为 Electron ABI
|
||||
- 构建前清理 `rm -rf release/ .next/`；构建 Windows 包后 `npm rebuild better-sqlite3` 恢复本地环境
|
||||
@@ -4,76 +4,12 @@
|
||||
|
||||
CodePilot — Claude Code 的桌面 GUI 客户端，基于 Electron + Next.js。
|
||||
|
||||
## 本地参考项目路径（上下文共享/存储）
|
||||
|
||||
为便于后续分析与实现对照，本机已拉取以下参考仓库：
|
||||
## 本地参考项目
|
||||
|
||||
- craft-agents-oss: `/Users/op7418/Documents/code/资料/craft-agents-oss`
|
||||
- opencode: `/Users/op7418/Documents/code/资料/opencode`
|
||||
|
||||
## Release Checklist
|
||||
|
||||
**发版流程（CI 自动打包 + 发布）：**
|
||||
|
||||
1. `package.json` 中的 `"version"` 字段更新为新版本号
|
||||
2. `package-lock.json` 中的对应版本（运行 `npm install` 会自动同步）
|
||||
3. 提交代码并推送到 `main` 分支
|
||||
4. 创建并推送 tag：`git tag v{版本号} && git push origin v{版本号}`
|
||||
5. **推送 tag 后 CI 会自动触发**（`.github/workflows/build.yml`）：
|
||||
- 自动在 macOS / Windows / Linux 上构建
|
||||
- 自动收集所有平台产物（DMG、exe、AppImage、deb、rpm）
|
||||
- 自动创建 GitHub Release 并上传所有产物
|
||||
6. 等待 CI 完成，在 GitHub Release 页面补充 New Features / Bug Fixes 描述
|
||||
7. 可通过 `gh run list` 查看 CI 状态，`gh run rerun <id> --failed` 重试失败的任务
|
||||
|
||||
**重要：不要手动创建 GitHub Release**，否则会与 CI 自动创建的 Release 冲突。如果需要本地打包测试，使用 `npm run electron:pack:mac` 但不要手动上传到 Release。
|
||||
|
||||
## 发版纪律
|
||||
|
||||
**禁止自动发版**：不要在完成代码修改后自动执行 `git push` + `git tag` + `git push origin tag` 发版流程。必须等待用户明确指示"发版"、"发布"或类似确认后才能执行。代码提交（commit）可以正常进行，但推送和打 tag 必须由用户确认。
|
||||
|
||||
## Development Rules
|
||||
|
||||
**提交前必须详尽测试：**
|
||||
- 每次提交代码前，必须在开发环境中充分测试所有改动的功能，确认无回归
|
||||
- 涉及前端 UI 的改动需要实际启动应用验证（`npm run dev` 或 `npm run electron:dev`）
|
||||
- 涉及构建/打包的改动需要完整执行一次打包流程验证产物可用
|
||||
- 涉及多平台的改动需要考虑各平台的差异性
|
||||
|
||||
**新增功能前必须详尽调研：**
|
||||
- 新增功能前必须充分调研相关技术方案、API 兼容性、社区最佳实践
|
||||
- 涉及 Electron API 需确认目标版本支持情况
|
||||
- 涉及第三方库需确认与现有依赖的兼容性
|
||||
- 涉及 Claude Code SDK 需确认 SDK 实际支持的功能和调用方式
|
||||
- 对不确定的技术点先做 POC 验证，不要直接在主代码中试错
|
||||
|
||||
**Commit 信息规范：**
|
||||
- 每次 commit 必须在 message body 中写清楚每个改动的具体内容和原因
|
||||
- 标题行使用 conventional commits 格式（feat/fix/refactor/chore 等）
|
||||
- body 中按文件或功能分组，说明：改了什么、为什么改、影响范围
|
||||
- 如果是修复 bug，说明根因是什么，不只是描述现象
|
||||
- 如果涉及架构决策（如选择方案 A 而非方案 B），简要说明理由
|
||||
|
||||
## Release Notes 规范
|
||||
|
||||
标题：`CodePilot v{版本号}`
|
||||
|
||||
正文必须包含：
|
||||
- **本版本更新内容**（New Features / Bug Fixes，按实际情况分区）
|
||||
- **Downloads**（各平台安装包说明）
|
||||
- **Installation**（各平台安装步骤）
|
||||
- **Requirements**（系统要求、依赖说明）
|
||||
- **Changelog**（自上一版本以来的 commit 列表）
|
||||
|
||||
## Docs 目录
|
||||
## Docs
|
||||
|
||||
- `docs/handover/` — 交接文档（架构、数据流、设计决策）。**检索前先读 README.md；增删文件后更新索引。**
|
||||
- `docs/research/` — 调研文档（技术方案、可行性分析）。**同上。**
|
||||
|
||||
## Build Notes
|
||||
|
||||
- macOS 构建产出 DMG（arm64 + x64），Windows 产出 NSIS 安装包或 zip
|
||||
- `scripts/after-pack.js` 会在打包时显式重编译 better-sqlite3 为 Electron ABI，确保原生模块兼容
|
||||
- 构建前清理 `rm -rf release/ .next/` 可避免旧产物污染
|
||||
- 构建 Windows 包后需要 `npm rebuild better-sqlite3` 恢复本地开发环境
|
||||
- macOS 交叉编译 Windows 需要 Wine（Apple Silicon 上可能不可用），可用 zip 替代 NSIS
|
||||
@@ -0,0 +1,6 @@
|
||||
# Docs 目录
|
||||
|
||||
- `handover/` — 交接文档（架构、数据流、设计决策）
|
||||
- `research/` — 调研文档（技术方案、可行性分析）
|
||||
|
||||
**规则：检索子目录前先读对应 README.md；增删文件后更新 README.md 索引。**
|
||||
@@ -0,0 +1,14 @@
|
||||
# Bridge 模块
|
||||
|
||||
多 IM 远程桥接系统，通过 Telegram（后续可扩展）远程操控 CodePilot 中的 Claude 会话。
|
||||
|
||||
## 关键约定
|
||||
|
||||
- `bridge-manager.ts` 中 `runAdapterLoop()` 必须在 `state.running = true` 之后调用（async IIFE 的 while 条件在首个 await 前同步求值）
|
||||
- `telegram-bot.ts`（通知模式）与 bridge adapter 互斥，通过 `globalThis` 上的 `bridgeModeActive` 标志协调，防止 HMR 重置
|
||||
- Offset 安全水位：`fetchOffset`（API 调用）与 `committedOffset`（持久化）分离，仅 handleMessage 完成后才推进 committed
|
||||
- 新增 adapter 只需实现 `BaseChannelAdapter` + 调用 `registerAdapterFactory()` 自注册 + `adapters/index.ts` 加 import
|
||||
|
||||
## 详细架构
|
||||
|
||||
见 `docs/handover/bridge-system.md`
|
||||
Reference in new issue
Block a user