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:
weichen
2026-09-29 14:20:37 +00:00
co-authored by Cursor
parent 7f5972007b
commit 0ea2ad297a
6 changed files with 170 additions and 0 deletions
+40
View File
@@ -0,0 +1,40 @@
# 通用规范采纳记录
- 项目/负责人:Logging-System / 仓库所有者 weichen
- 状态:active
- 规范位置:`deps/development-guidelines`
- 规范性文档目录:`policy/`
- 过程文档位置:`docs/records/`(项目内固定目录豁免。集成说明留在 `docs/integration.md`,因为它描述当前合同而不是某次任务。方案与验证放 `docs/records/`。任务主记录在 Gitea Issue/PR。)
- 版本权威:父仓 gitlink;可读标签:无(内容版本 `0.1.0-draft.6`,提交 `26b562d2e34fbc560711296a309c91c74ffc55b1`)
- 批准/生效依据:本仓接入提交
- 替代范围和迁移说明:无既有根 `AGENTS.md`。
| 规范/工作流 | 适用条件与范围 | 采纳或不适用理由 | 执行方式/证据 |
|---|---|---|---|
| core/baseline.md | 日常工作 | 日志是失败定位的另一半 | manual |
| workflows/delivery.md、debugging.md、handoff.md | 交付、排障与交接 | 排障会直接使用本库 | manual |
| standards/collaboration.md | 消费方固定版本 | 本仓不跟随消费方分支 | manual |
| standards/verification.md | 并发、脱敏、排空 | conformance 与 `go test` | manual |
| standards/observability.md | trace、级别、重放 | 本仓实现日志半边 | manual |
| standards/configuration.md | 文件、环境变量、出口 | `config.Load` / `LOGSYS_*` | manual |
| standards/security.md | 脱敏与采集 token | 写前与入库前各脱敏一次 | manual |
| standards/failure-containment.md | 队列满丢弃最新一条 | 不阻塞业务 goroutine | manual |
| standards/module-contracts.md | 不导入错误码库 | 鸭子接口是稳定边界 | manual |
| standards/documentation.md | 三层文档 | `docs/` 与 `docs/records/` 分开 | manual |
| standards/multi-repo.md | 被 submodule 消费;示例模块用相对 replace | 主模块不嵌套错误码库 | manual |
| standards/data-reliability.md | JSONL 采集文件 | 无事务数据库;文件是日志投影 | manual |
| standards/agent-execution.md | 不执行 Agent | 只记录调用方给出的字段 | 不适用 |
| standards/release-operations.md | 无制品流水线 | 消费方固定 gitlink | 不适用 |
| workflows/automation.md | 无独立定时任务 | 异步批导出是库行为,不是运营自动化 | 不适用 |
## 项目差异
| 原规则/章节 | 项目采用方式 | 原因与风险 | 负责人/复查条件 |
|---|---|---|---|
| documentation.md 过程仓默认独立仓库 | `docs/records/` 豁免 | 个人项目。风险同其他三仓 | 采集服务对外长期运行时复查 |
## 本次升级或首次接入验证
- 子模块固定 `26b562d2e34fbc560711296a309c91c74ffc55b1`。
- `examples/trace` 仍使用自己的 `go.mod` replace,不改为依赖 `deps/` 下的错误码副本。
- 回退只恢复规范 gitlink 与入口文件。