Adopt the task-startup gate and commit format in AGENTS.md #1

Merged
weichen merged 1 commits from feature/entry-docs-gate into main 2026-09-30 03:15:26 +00:00
Showing only changes of commit d7dde2aa9e - Show all commits
+14 -23
View File
@@ -1,28 +1,19 @@
# 项目工作入口
# Agent 工作说明(Logging-System)
本项目采纳的通用规则:[核心规则](deps/development-guidelines/core/baseline.md)。
采纳范围、生效状态及项目差异:[采纳记录](policy/guidelines-adoption.md)。
项目事实、测试和环境入口:[PROJECT.md](PROJECT.md)。
本仓开发遵循 Development-Guidelines(Dev 仓 `deps/development-guidelines`,gitlink 固定版本):
核心规则见其 `core/`,按任务触发阅读 `standards/` 专题;日常交付走 `workflows/delivery.md`。
- 启动:阅读以上短入口;只加载本次任务触发的专题。
- 普通交付:[交付流程](deps/development-guidelines/workflows/delivery.md)。
- 并行开发/正式测试/审核/合入:[共同基线与同步节点](deps/development-guidelines/standards/collaboration.md),必须确认并实际同步最新权威目标。
- Bug/异常:[系统性排障](deps/development-guidelines/workflows/debugging.md)。
- 会话结束/换机器/换客户端/换执行者:[会话、执行者与机器交接](deps/development-guidelines/workflows/handoff.md),状态写入任务主记录,不依赖本地会话历史。
- 测试与验收:[验证标准](deps/development-guidelines/standards/verification.md)。
- 模块/接口:[模块契约](deps/development-guidelines/standards/module-contracts.md)。
- 错误与过程事件:[可观测性](deps/development-guidelines/standards/observability.md)。
- 配置:[配置来源与实例隔离](deps/development-guidelines/standards/configuration.md)。
- 其他专题:按 [任务索引](deps/development-guidelines/README.md) 选择。
## 任务启动门禁
项目补充硬边界:
- 任务启动或恢复后,第一次写操作前在 Dev 仓运行 `make precheck` 并附完整输出(本仓作为子仓随父仓编排);
本仓独立开发时核对工作树 clean、与权威 origin/main 同步,并按任务触发读对应专题。
- 从权威 origin/main 固定共同起点 R0,建 feature|fix|hotfix/<slug> 分支(Dev 仓 `make task-start` 自动化);
任务中途不重复 precheck。
- 验收、请求审核、合入前各同步一次最新目标分支并附证据;合入后回收任务工作区与已合入分支。
- 提交主题行:英文祈使句一行(≤100 列,不以句点结尾);body 写 `Why: / Evidence: / Impact: / Refs:`。
- 本库只依赖标准库。识别错误码使用 `ErrorCode()` / `ErrorFields()` 鸭子接口,不 `import error-code-system`。
- 写前脱敏覆盖 JWT、sk-key、Bearer、api_key、password 形状;采集服务写入时再脱敏一次。
- 异步队列满时丢弃最新一条并计数,不阻塞业务 goroutine。
- 追踪头为 `X-Trace-Id`。`trace_id` 回答哪一次请求,不替代调用方自己的 `run_id`。
## 仓内规则
任务权威:Gitea 仓库 `weichen/Logging-System` 的 Issue 与 Pull Request。
规范性文档目录与过程记录位置:`policy/`;过程记录豁免目录 `docs/records/`。
默认集成基线和提交身份:`main`。权威远端 `ssh://git@git-ssh.u1680832.nyat.app:31411/weichen/Logging-System.git`。
共享环境/发布入口及授权:采集服务默认 `:8092`。配置了 token 时要求 `Authorization: Bearer` 或 `X-Log-Token`。令牌值不入库。
- 模块边界、公开契约与隔离档位见 `policy/modules/`(如有)与 PROJECT.md。
- 跨仓 gitlink 变更须经组合验证后在 Dev 仓推进;受保护分支经 PR 合入。
- 验证命令见 PROJECT.md「验证」节;完成声明须附实际命令输出证据。