From f4a26e59618c04fd960a39d57dae9cf372601a33 Mon Sep 17 00:00:00 2001 From: Codex Date: Mon, 1 Jun 2026 21:54:58 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=98=8E=E7=A1=AE=20SPEC=20=E6=96=87?= =?UTF-8?q?=E6=A1=A3=E7=9B=B4=E6=8E=A5=E6=8E=A8=E7=9B=AE=E6=A0=87=E5=88=86?= =?UTF-8?q?=E6=94=AF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- AGENTS.md | 1 + docs/reference/spec-v01-documentation-governance.md | 2 ++ 2 files changed, 3 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 90f8373..c5fc9d3 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -7,6 +7,7 @@ AgentRun 是面向 UniDesk 与 HWLAB 的共享 Agent 执行基础设施。本仓 - P0: AgentRun 的所有长期文档、过程文档、issue、PR 标题、PR 正文、PR 评论和交付说明一律使用中文。 - P0: 代码标识符、API 路径、命令、配置键、日志字段、协议字段和必要英文专有名词可以保留英文，但解释性文字必须使用中文。 - P0: 外部英文资料只能作为引用或短摘录出现；落入本仓库的设计结论、验收标准和操作说明必须转写为中文。 +- P0: SPEC 和长期参考文档变更不创建 PR，必须在完成本地审查后直接提交并推送到对应目标分支；过程计划和证据写入 GitHub issue 评论区，不能用文档 PR 代替直接落库。 ## Critical Source Worktree Rule diff --git a/docs/reference/spec-v01-documentation-governance.md b/docs/reference/spec-v01-documentation-governance.md index dd696e1..19c592f 100644 --- a/docs/reference/spec-v01-documentation-governance.md +++ b/docs/reference/spec-v01-documentation-governance.md @@ -8,6 +8,7 @@ - `docs/reference/spec-v01-*.md` 是 `v0.1` 微服务、CI/CD、CLI、运行面和系统能力的权威规格。 - `docs/reference/` 只保存长期稳定、可复用的规格、边界、入口、判定标准和稳定 runbook。 - 计划、阶段拆解、一次性排障、临时报告和执行证据进入 GitHub issue 或 PR 评论，不直接沉淀为仓库长期文档。 +- SPEC 和长期参考文档变更不创建 PR。修改 `AGENTS.md` 或 `docs/reference/*.md` 时，必须在目标 branch 对应 worktree 完成审查后直接提交并推送到目标分支；GitHub issue 评论区用于记录计划、过程和证据，不能用文档 PR 作为落库路径。 - `docs/` 根目录不得堆放 Markdown 报告或 JSON dump；机器可消费契约应放入未来的 `protocol/`、`deploy/` 或源码相邻目录，临时输出放 `/tmp`、`.state` 或 CI artifact。 - 不维护独立 `TEST.md`；人工测试和验收场景必须作为对应 `spec-v01-*.md` 的“测试规格”子项维护。 - 旧 `dev/prod` 管理说法不再作为当前规格；AgentRun 从 `v0.1` 开始按 `v0.1`、`v0.2`、`v0.3` 版本 lane 滚动。 @@ -50,6 +51,7 @@ 4. 与 `v0.1` 规格冲突的旧 `dev/prod`、`/root/agentrun` 默认 source 目录、`agentrun_dev`、`agentrun_prod` 说法必须删除或改为历史背景。 5. 发现独立 `TEST.md` 或测试计划文档时，先把仍有效的测试场景蒸馏到对应 `spec-v01-*.md` 的“测试规格”小节，再删除源文件。 6. 未实现规格必须在对应 spec 的“规格的实现情况”中明确写成 `未实现` 或 `未完全实现`，不要用散落 TODO 代替。 +7. SPEC 或长期参考文档完成修改后，直接提交并推送目标分支；若误建文档 PR，必须关闭 PR，并把同一变更直接落入目标分支。 ## v0.1 当前权威入口