Skip to content

docs(review): 存量债必须当次建单,审查增加架构归属对账 - #1777

Merged
xiaoyumuxi merged 4 commits into
previewfrom
docs/review-debt-gate
Nov 6, 2026
Merged

xiaoyumuxi merged 4 commits into
previewfrom
docs/review-debt-gate

Conversation

@xiaoyumuxi

Copy link
Copy Markdown
Collaborator

关联 Issue / Linked issue

无

PR 类型 / Type

  • feat:新功能或用户可见的改进
  • fix:缺陷修复
  • docs:文档、Agent Note、Skill 等规则文件
  • release:稳定版发布准备

改动说明 / What changes

背景 / Why

现有审查规则只看本次增量,架构漂移(未沉入 Core 的逻辑、两端各写一份的实现)永远进不了 Findings;存量债只被记成"观察项",PR 里写一句"后续处理"就能合入。结果是方向问题没有 owner,同一份逻辑在两端各写一份也没人负责收口。

这次收紧两件事:

  1. 存量债发现即建单。 "修"可以另排,"建单"必须当次完成。没有 Issue 编号的"以后改"属于流程阻塞项,合并前补齐。
  2. 让逻辑归属判断有可核对的证据,而不是"看起来像业务逻辑",并给它一个固定的落笔位置。

改动 / Changes

  • develop-lithe 第九节:新增三个执行步骤(归类 → 查重建单 → 回填编号),给出"建不了单时必须写明原因并标为未完成"的降级路径,并列出等同于没有建单的写法("后续处理""以后再重构""另开 PR""另行安排""记录在此""已知问题,暂不处理""本次先记下")。规则 1 里重复的写法清单改为指向这份唯一清单,避免同文件内两处漂移。
  • lite-code-review/references/review-policy.md:第 10 条要求归属对账落到证据——判为 Core 必须给出兼容命令名与 fixture 路径,判为平台必须指出实际调用的原生 API,两端各有一份实现时逐项对照文件与符号;第 16 条从"建议提交 Issue"改为"必须已经提交",无编号按流程阻塞项报告,写法清单指向 develop-lithe 第九节而不是再抄一份。
  • lite-code-review/references/finding-severity.md:新增"流程阻塞项"档位——不属于 P0–P3,不要求改代码,只要求补齐流程证据,合并前必须完成;同时修掉"不要报告变更前就存在的问题"与新规则的冲突。
  • lite-code-review/references/output-template.md:Scope Check 增加 #### 架构归属对账 表格和 未沉入清单;Observations 必须带已提交的 refactor Issue 编号,无编号的移入 Findings 按阻塞报告;纯呈现、文案或配置调整可写"无",避免形式化。
  • lite-code-review/references/local-review.md:历史问题不能只当背景,必须有已提交的 Issue;按触及路径强制运行 verify-service-boundaries.sh、verify-shared-contracts.sh、verify-windows-boundaries.sh 并把结果写进 Verification。
  • lite-code-review/SKILL.md:输出分类加入"流程阻塞项",避免存量债混进"观察项"被淡化。
  • AGENTS.md:开发与协作新增第 6 条入口提醒,指向 develop-lithe 第九节,不复制规则细节。

不在本 PR 范围内 / Out of scope

  • 不新增脚本或 CI 门禁。 这是刻意的:正则门禁只能校验字面,"写了但等于没建单"的写法照样能过,还会逼作者填"无"两个字。改为让 Agent 按可执行步骤判断。
  • 不做存量债盘点。 规则上线后需要一次清账(把已知的存量债批量建单),否则前期会有一批 PR 被卡;这部分单独跟进。
  • 不改 PR 模板。 模板里 ### 无用代码与重构 与 ### 逻辑归属 两节已经要求填写 Issue 编号,与本 PR 一致,无需调整。

类型专属:docs

  • 只改文档、Agent Note、Skill、入口文件等,没有产品代码的行为变化(有则改选 feat 或 fix)
  • [N/A] 长期决策、取舍和约束写在 .agents/notes/;本 PR 未改 Note,./scripts/agent-notes/verify-agent-notes.sh 不适用
  • 规则只在真源(Skill、Note)里写一份,入口文件只留指针,没有复制出会漂移的第二份
  • 文中的路径、命令、链接已核对真实存在(三个脚本路径已用 git 核对并在 preview 基线上实际运行)
  • [N/A] 未改 shared/contracts/plugins/v1/

范围检查 / Scope checks

功能矩阵 / Feature matrix

N/A:只改规则文档,没有新增用户可见能力,也没有改变跨平台行为。

统一日志系统 / Structured logging

N/A:没有新增或改动生命周期事件、终态或失败路径。

界面文案 / i18n

N/A:没有新增用户可见文字。

逻辑归属 / Logic placement

N/A:没有新增或修改业务逻辑;本 PR 改的是"业务逻辑该放在哪一层"的判断规则本身。

性能与内存 / Performance and memory

N/A:没有新增后台功能、子进程、缓存、定时器或依赖。

设置 / Settings

N/A:没有涉及设置项、设置页或对话框选项。

插件与共享契约 / Plugin and shared contracts

N/A:没有改动 shared/contracts/、插件能力或宿主方法。

发行包与资源 / Bundle and resources

N/A:没有新增运行时资源、下载物、解压物或构建步骤。

无用代码与重构 / Dead code and refactoring

N/A:本次只有 Markdown 规则文档改动,没有代码改动;本 PR 未发现新的存量债。


验证 / Verification

命令或操作 平台 结果
分支基点 origin/preview = 0317143d1 macOS 通过:git worktree add -b docs/review-debt-gate ... origin/preview
git diff --stat macOS 7 files changed, 69 insertions(+), 12 deletions(-)
git diff --check macOS 通过,无空白问题
./scripts/architecture/verify-shared-contracts.sh macOS 通过:10219/10219 词条,fixtures 合法
./scripts/architecture/verify-service-boundaries.sh macOS 通过:bundle 只读、构建安全、i18n、分层四项
./scripts/windows/verify/verify-windows-boundaries.sh macOS 通过
grep -c "以后再重构" 跨文件核对 macOS develop-lithe 1 次,其余 6 个文件 0 次,确认写法清单只有一份

未能执行的检查和原因:

  • 未运行 macOS / Windows 构建与测试:本次只有 Markdown 规则文档改动,无产品代码路径受影响。
  • 未验证规则生效后的实际 review 输出:需要在一次真实 PR 上才能体现,属于规则使用阶段的验证。

提交前确认 / Final checks

  • 分支从最新的 preview 创建;目标分支 preview
  • 以 Draft 提交,本地验证通过后才标记 ready
  • 没有无关改动,没有提交 .build/、target/、dist/、.artifacts/ 等产物,没有凭据和个人路径
  • 本次没有启动任何 Lithe 应用或子进程,无残留

@ghfind-review ghfind-review Bot added the review: high ghfind author score; see https://ghfind.com label Nov 6, 2026
- develop-lithe 第九节:新增归类、查重、回填编号三步执行,以及「以后处理」等
  等价违规写法清单;建不了单时必须写明原因并标为未完成,合并前补齐
- lithe-code-review:review-policy 第 10 条要求归属对账带 Core 命令名与 fixture,
  第 16 条从「建议提交」改为已建单硬要求并指向唯一写法清单
- finding-severity:新增「流程阻塞项」档位,不要求改代码、只要求补流程证据
- output-template:Scope Check 增加架构归属对账表与未沉入清单,观察项必须带编号
- local-review:历史问题不能只当背景;按触及路径运行三个边界检查脚本
- AGENTS.md:开发与协作新增第 6 条入口提醒
- review-policy 新增「取证手段」一节:把 17 条「检查是否」映射到可复核动作
  (调用方影响面、引入提交、契约消费者、分层脚本、性能基线、i18n、发行目录)
- review-policy「成熟能力复用审查」不再逐条复述 develop-lithe 第三节,改为只写
  审查侧取证要求并给出默认严重度
- finding-severity 新增格式示意:可复核的 Finding 与「该报没报」的对照
- SKILL.md 增加自审假设提醒:同一 Agent 连续实现和审查会沿用实现时的假设
- finding-severity 拆成「严重度 × 归属」两维:P0–P3 描述影响,归属分本次引入 /
  存量(#issue)/ 存量未建单;阻塞只有 P0、P1 和存量未建单三种;原来的
  「流程阻塞项」独立档位并入归属维度,概念少一个
- output-template 新增 Checked and cleared:记录查过并排除的项和依据,
  无 Finding 时也能证明看过
- output-template 无 Finding 时 Scope Check 合并为三行,其余检查项一行说明
  为什么不适用,避免空转
- develop-lithe 第五步统一术语,去掉同义两名的写法
- review-policy「Lithe 特别边界」不再逐条复述目录归属,改为指向 develop-lithe
  第三节,只保留审查侧注意事项,删掉六条纯复述
- review-policy「需求与范围判断」改用 finding-severity 的两个维度,去掉与新归属
  模型不同名的“历史问题”
- local-review 与 SKILL.md 同步改为“存量”表述,并修掉一处被换行拆开的旧词
@xiaoyumuxi
xiaoyumuxi force-pushed the docs/review-debt-gate branch from c7cfb19 to d813b9a Compare November 6, 2026 10:34
@xiaoyumuxi
xiaoyumuxi marked this pull request as ready for review November 6, 2026 10:35
@xiaoyumuxi
xiaoyumuxi merged commit 6452184 into preview Nov 6, 2026
6 of 7 checks passed
@xiaoyumuxi
xiaoyumuxi deleted the docs/review-debt-gate branch November 9, 2026 05:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review: high ghfind author score; see https://ghfind.com

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant