Skip to content

Commit 7dcfb4f

Browse files
committed
docs: CLAUDE.md 语言精简
1 parent 8e14103 commit 7dcfb4f

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

CLAUDE.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# airgate-sdk — Claude 开发指南
22

3-
> 叠加在 monorepo 根 `../CLAUDE.md` 之上。SDK core 与所有插件之间的**契约层**,改动影响面最大,务必先读「🚫 红线」。
3+
> 叠加于根 `../CLAUDE.md`。SDK core 与全部插件之间的**契约层**,改动影响面最大,先读「🚫 红线」。
44
> 生态边界依据见 `../airgate-core/docs/architecture/ecosystem-v2.md`
55
66
## 🚫 红线
77

8-
- **不要把 core 的产品逻辑塞进 SDK**。SDK 只放:协议 ABI、插件接口、运行时桥、devkit、前端 theme用户/账号/计费/调度等业务是 **core** 的事(这是 ecosystem-v2 明确的边界审计结论)。
9-
- **`protocol/proto/` ABI**改了必须 `make proto` 重新生成并提交 `*.pb.go`**保持向后兼容**(字段只增不改不删、不复用 tag 号)。破坏性变更会同时打挂 core 与所有插件
10-
- **`sdkgo/` 的插件接口是公共 API**`GatewayPlugin`/`ExtensionPlugin`/`MiddlewarePlugin`/`宿主能力` 签名变更属于破坏性变更,需同步评估所有插件仓
8+
- **勿将 core 产品逻辑写入 SDK**。SDK 仅放协议 ABI、插件接口、运行时桥、devkit、前端 theme用户/账号/计费/调度等业务归 **core**ecosystem-v2 边界审计结论)。
9+
- **`protocol/proto/` ABI**改后须 `make proto` 重新生成并提交 `*.pb.go`,并保持向后兼容(字段只增不改不删、不复用 tag 号);破坏性变更将打挂 core 与全部插件
10+
- **`sdkgo/` 插件接口为公共 API**`GatewayPlugin`/`ExtensionPlugin`/`MiddlewarePlugin`/宿主能力 签名变更属破坏性变更,须同步评估全部插件仓
1111
-`theme/``make theme`,提交生成的 `dist`/devserver CSS。
1212
- 生成代码(`*.pb.go`、theme `dist`)不可手改。
1313

@@ -16,19 +16,19 @@
1616
| 目录 | 角色 |
1717
|---|---|
1818
| `protocol/proto/` | gRPC 协议定义 = ABI(core ↔ 插件) |
19-
| `sdkgo/` | Go 插件接口:`gateway.go` / `extension.go` / `capability.go` / `event.go` / `errors.go` |
20-
| `runtimego/grpc/` | 插件运行时桥(Go 实现接到 gRPC) |
19+
| `sdkgo/` | Go 插件接口:`gateway.go` / `extension.go` / `capability.go` / `event.go` / `errors.go` |
20+
| `runtimego/grpc/` | 插件运行时桥(Go 实现接入 gRPC) |
2121
| `devkit/devserver/` | 插件脱离 core 的独立调试服务 |
2222
| `theme/` | 前端主题包 `@doudou-start/airgate-theme` + devserver theme.css |
2323

24-
## 命令(`airgate-sdk/`
24+
## 命令(`airgate-sdk/`
2525

2626
```bash
2727
make proto # 改 proto 后重新生成(装固定版本 protoc)
2828
make proto-check # 校验 proto 生成代码无漂移
2929
make theme # 构建 theme 包 + devserver theme.css
30-
make test # race + coverage 的 Go 测试
31-
make ci # 完整 CI:lint+test+vet+build+proto-check+theme-check
30+
make test # Go 测试(race + coverage
31+
make ci # 完整 CI:lint + test + vet + build + proto-check + theme-check
3232
```
3333

34-
提交前跑 `make ci`,proto/theme 的漂移检查在这里把关
34+
提交前运行 `make ci`,proto/theme 漂移检查在此把关

0 commit comments

Comments
 (0)