docs: require full issue body reads

This commit is contained in:
Codex
2026-07-02 12:36:15 +00:00
parent 9c08a051aa
commit 92d332e26c
2 changed files with 3 additions and 0 deletions
+1
View File
@@ -10,6 +10,7 @@ GitHub issue/PR 正式读写必须走 `bun scripts/cli.ts gh ...` 或 `trans gh:
## 高频规则
- Issue/PR 正文、评论、关闭/重开、PR 描述和 merge closeout 默认中文。
- 需要理解、拆解、执行或关闭 GitHub issue 时,必须阅读 issue 正文全文;即使 `gh issue view` 触发 stdout dump wrapper,也要跟随 `dump.path` 或改用 `trans gh:/... cat` 读完整正文,不能只凭 compact summary、body preview、body SHA 或截断摘要下结论。
- 新 issue 正文必须包含 `目标合并分支: <repo branch/lane>`;不需要合并时写 `目标合并分支: 不适用`
- 大计划、后续阶段和独立改进方向创建新 issue;已有 issue 评论只写短进展、证据、阻塞和链接。
- 规划型、多阶段、架构/API/平台运维类 issue 第一阶段必须 `P0 SPEC 先行`;细则见 [references/full.md](references/full.md) 的 `多阶段 Issue 与 SPEC-First`
@@ -103,6 +103,8 @@ bun scripts/cli.ts gh issue view <number|url|owner/repo#number> \
`read` 是兼容别名。支持 `owner/repo#number` shorthand(如 `pikasTech/HWLAB#1024`)。
默认 stdout 是 issue 元数据表格、短摘要、body chars/SHA/preview 和 Next 命令,不输出完整 body。人工读取 issue/PR 正文优先走 `trans gh:/owner/repo/issue/<number> cat|rg``trans gh:/owner/repo/pr/<number> cat|rg`;脚本消费或字段读取使用 `--json <fields>`,全量排障才用 `--full`/`--raw`
Issue 理解、拆解、执行、调度子代理、PR review 归因或 closeout 前必须读完整正文;compact summary、body preview、body SHA、comment count 和 dump metadata 只能用于定位,不能作为需求理解依据。若 `gh issue view ... --json body|comments|--full|--raw` 触发 stdout dump wrapper,必须跟随 `data.dump.path` 读取完整 payload,或改用 `trans gh:/owner/repo/issue/<number> cat` 读取完整一楼正文。需要评论上下文时,继续读取完整 comments;默认 comments preview 不足以支持结论。
`--json comments` 默认只返回 comment id、URL、作者、时间、正文字符数、body SHA 和短 preview`--full` 仍保持评论列表有界,只有 `--raw` 会显式展开所有评论正文。读取单条完整 comment body 使用 `gh issue comment view <commentId> --full`,显式 `--json` 路径的 comments 位于 `.data.json.comments`,不要依赖顶层重复 comments。
### 创建