Pin Development Guidelines and add the project entry documents.
The guidelines submodule records the reviewed commit so project rules stay discoverable without copying them into this repository. Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
@@ -0,0 +1,40 @@
|
||||
# 接入开发规范并说明被父仓固定引用的方式
|
||||
|
||||
状态:已批准范围;owner:weichen;主任务:本仓接入提交。
|
||||
授权与交付终点:挂载 Development-Guidelines,补齐项目入口,并在 README 说明消费方如何用 submodule 与 `replace` 固定本库。不修改码值,不导入日志库。
|
||||
并行基线:Error-Code-System `main` @ `b67696d393e7abfbdd16fdde1064c07f5ecd2f72`。日期 2026-09-29。
|
||||
|
||||
## 问题与证据
|
||||
|
||||
本库已定义 `agent.*` 与 `squad.*` 种子码和映射文档,但消费方尚未把本库固定为 submodule。README 的依赖示例使用同级目录 `../Error-Code-System`,与各仓统一的 `deps/` 布局不一致。没有根 `AGENTS.md` 与采纳记录。
|
||||
|
||||
## 目标与边界
|
||||
|
||||
- 规范子模块放 `deps/development-guidelines` 并固定 SHA。
|
||||
- README 增加 `deps/error-code-system` 的消费示例,保留「本库不依赖另外三个业务仓」的边界。
|
||||
- 非目标:不改种子码;不把 Agent-Native 或日志库引进来。
|
||||
|
||||
## 选择与实施
|
||||
|
||||
过程记录放 `docs/records/`。映射文档保持在 `docs/`,因为它们描述当前码合同,不是某次任务证据。
|
||||
|
||||
## 兼容、迁移与恢复
|
||||
|
||||
同级目录 `replace` 对尚未迁移的旧工作区仍然有效。新消费方使用 `./deps/error-code-system`。回退本提交不影响已发布的码字符串。
|
||||
|
||||
## 验收
|
||||
|
||||
| 需求/验收条件 | 负责模块/契约或不变量 | 验证方法/用例 | 实际结果/证据 |
|
||||
|---|---|---|---|
|
||||
| 规范 gitlink 固定 | deps/development-guidelines | `git submodule status` | 计划阶段待执行 |
|
||||
| 既有测试保持通过 | 全模块 | `go test -count=1 ./...` | 计划阶段待执行 |
|
||||
| README 给出 deps 消费方式 | README | 人工阅读 | 计划阶段待执行 |
|
||||
|
||||
| 用户/系统条件 | 检查层级与方法 | 预期结果 | 必需环境/授权 |
|
||||
|---|---|---|---|
|
||||
| 未知码 | conformance | 回落 `sys.unknown_code` | 无 |
|
||||
| 别名 | `errcode show` 或单测 | 旧字符串回到规范码 | 无 |
|
||||
|
||||
## 决策与剩余项
|
||||
|
||||
消费方(Agent-Native、Agent-Squad)在各自仓库提交 gitlink。本仓不记录那些父仓的 SHA。
|
||||
Reference in New Issue
Block a user