Files
gplan-2/design/engineering/process-conventions.md
T

19 KiB
Raw Blame History

流程规范(Dungeon Sweeper)

约束范围:一切批次的流程纪律——车道(代码面 worktree 批/其余主区直改)、五段流水线、批次工作流、测试执行细则、像素件工作纪律。 分工:硬性红线的一句话索引在 AGENTS.md「硬性红线」;本文承载其操作细则;批次开工前通读本文。

开工任何批次前必须通读本文。

1. 分支纪律(车道铁律)

改动按文件性质分两车道(2026-10-26 用户裁,取代 2026-09-19 立的「一切改动走 worktree」铁律;判据与 §3 第 8 条改动域划分同一):

  1. worktree 批车道(唯一强制面=代码面):一切触及代码面(game/ 下非 .md 的行为载体:代码、测试脚本、探针、场景、数据表、素材)的改动——迭代实现批与触及代码面的工程改动(如纯测试维护)——先建独立 worktree:git worktree add ../g-plan2-<任务名> -b <任务分支>;所有改动与验证都在 worktree 内进行(未跟踪文件不会出现在新 worktree,需手工搬运);建区后立刻跑 tools/setup_worktree_userdir.sh——给该区独立 Godot user 目录(测试夹具、试玩日志、截图产物不与其他区共用;主区不生成,真实档保持原位)。迭代批开工细则见 §3 与 iter 技能
  2. worktree 批收尾:批次收口顺序固定为冻结 → 件核 → 并 master → 重塑 → 跑一次域闸 → 合回——代码与断言改完即冻结,全仓件核 grep 查残留;master 已被别的批次推进时先 git merge master 解冲突(必须在跑闸之前,闸跑完再并=那次闸白跑);重塑=迭代分支(iter 形)在跑闸前执行 python tools/reshape_cards.py,把分支线性史按卡末态快照压成一卡一笔(可选追加一笔纯文档收尾),master 台账由此每卡一行——工具自带「重塑前后树逐字节一致」断言与 backup 分支,不改任何文件内容;非迭代工程小批免重塑;然后按本批改动域跑一次 tools/run_all_gates.sh(见 §3.9),全绿后在主工作区 git merge --no-ff <任务分支>(合回闸对迭代分支数卡校验,未归卡提交拦下),再 git worktree remove+删分支。闸后代码面不得再改一个字节(回执作废须重跑),只允许追加 reports/、design/ 等文档件提交。游戏类测试(冒烟/单测/MC/探针)批内默认零执行(两入口铁规,见 §4),用户点名或当场问才跑
  3. 直改车道(代码面之外的一切面):design/、reports/、tools/、根规则与清单文件、game/ 内 .md、.zcode/、.qoder/——主工作区直接改、直接提交,无 worktree、无冻结/件核/合并仪式。验收=commit 点 git pre-commit 钩子(tools/hooks/pre-commit,经 core.hooksPath 挂载,在位性由 run_all_gates.sh 跑批自检)现场跑 tools/run_all_gates.sh --docs(秒级文本扫描):绿即落地,红即拦下,修红后重新 commit 钩子自动重跑;跑完把闸输出呈报对话即完成义务。预期大体量改动(跨文档结构重构等)时由用户开工点名自愿开 worktree,非规则强制
  4. 执法分层(全机械,零自觉依赖):①git pre-commit 钩子——直改车道的闸机检,并对主工作区直提代码面的提交一律拦(代码面唯一合法路径=worktree 批合回);任务 worktree 内的代码面提交跳过(归批末闸+合回闸管,不打扰迭代批中间提交)。②.zcode/hooks/worktree-guard.sh(PreToolUse,本机件不入 git)——agent 侧:主工作区代码面的 Edit/Write 与 staged 含代码面的 commit 拦截、git commit --no-verify 拦截(该旗标仅属用户)、合回闸回执六况校验(§3.9)。git 层钩子对一切提交者生效(含用户手工提交,紧急出口 --no-verify);ZCode 层只约束 agent

2. 五段流水线

需求改动(游戏代码,含随逻辑写/改的测试)按五段流水线走:登记 → 文档设计/美术设计(两条设计线)→ 写需求卡片 → 迭代编排 → 实现;工程/文档设计/美术素材三类改动不走写卡与编排段,走「登记 →(如需设计讨论)→ 用户发令直改 → 主区直改+commit 点闸 → 完成删条目」(车道细则见 §1)。两层口径(2026-10-25 用户立):需求卡片=需求单位的实施文档,任何工作量皆可写、皆可编入迭代;工作量限制只属迭代层——迭代估时总量 <5 个工作日=「冻结待凑批」,不可开工。段间不自动流转,每段转进由用户发令;每段一个技能入口(五者均装于项目 .zcode/skills/:doc-design/asset-ingest/req-card/iter-plan/iter),登记不立技能(条目格式由流水线闸强制)。设计工作在会话内进行、用户主导、禁无监管自跑。

段 入口技能 产出 出入口铁律
一·登记 无(闸管格式) 待办清单条目 条目=标题登记元数据(日期/来源/可选优先级)+正文四属性(实况/缺口/改动面/状态);标题登记后不再变,正文随进程演进。格式与状态机权威=doc-conventions 第 12 节
二·文档设计/美术设计 doc-design(文档线,兼任反哺点写入)/asset-ingest(美术录入;样张素材由用户主导产出) GDD 文档或 art-bible/过审样张素材 用户提起或从待办清单取出;会话内进行、用户主导、禁无监管自跑;经用户点头确认心智一致才许写入文档;完成判据=待裁点清零,带未裁点的是讨论稿;设计线闭合凭据记入待办清单实况清单(文档线=文档路径+版本号,美术线=art-bible 条款版本);缺哪条线写在缺口属性,闭合与否写在状态段
三·写需求卡片 req-card 需求卡片 设计线闭合后用户发令;新玩法/新系统/新内容必须有设计定稿前置,例外=需求性工程条目(缺陷修复/重构等改游戏行为)凭实况里的证据指认跳过设计线;配套维护类(工程债/测试基建/工具维护,不动游戏行为)=工程改动直改类,不走本段,登记后「待执行」由用户发令直改;卡片必经 grilling 多轮复核、零待裁点才成立;写完在待办清单状态记「已写卡」,卡片路径记入实况清单(防遗忘)
四·迭代编排 iter-plan roadmap 迭代行 编排四查:①每卡卡片文件存在 ②每卡设计闭合凭据齐(或需求性工程条目的证据指认)③估时与冻结线——所选卡估时按区间中值求和(单位工作日、写精确值不取整):卡片任何工作量均可编入(2026-10-25 用户立:工作量限制属迭代层、非卡片层);编入后迭代总量 <5 个工作日=迭代行状态「冻结待凑批」、不可开工,凑批 ≥5 后由编排段改「待开工」(迭代体量偏好,2026-10-21 用户立、2026-10-25 改冻结制);5–10 个工作日为常规区间;超过 10 个工作日须经用户确认(确认前呈报整批/拆批两案等裁,禁自行拆分或塞入),确认后迭代行随带日期特批标记;超过 20 个工作日禁止编(硬上限,用户确认也不放行,必须拆批)④写完 roadmap 行后跑流水线闸确认绿;编入未完成迭代,新开迭代行经用户确认
五·实现 iter 代码与配置,可运行的游戏 需求卡片永不单独施工,统一由用户指定迭代号触发(=U0 开工令),按 iter 技能与本文 §3 执行;本段是代码实现批:禁写 design/ 与根规则文件,产出物只落 reports/(见 §3 第 12 条);设计权威文档(GDD/art-bible)批内一律不更新;完成人闸=实机目检清单+实现决定记录写齐即完成批内义务

实现段零裁断:实现段的输入在编排段出口已锁死(卡片零待裁点+设计闭合凭据齐+编排四查过)。实现中冒出卡片没写清的分歧=上游缺陷——停该卡、待办清单状态回退+缺口补记,退回上游;禁自答、禁内联提问求裁断;该卡停摆不阻塞同迭代其他卡。环境故障与测试红走异常分级(自救重试/记录继续/停机呈报)。代拍板白名单保留:授权发生在卡片审问阶段,实现只执行预授权;超白名单/超卡片明列范围事项记入实现报告「实现决定记录」节备案,不另立追认单。

流水线闸:tools/pipeline_gate.py 机检待办清单与 roadmap 两文件的格式与互相引用;已注册进 run_all_gates.sh 文档域。流程文档的条目格式、迭代行格式与状态机细则见 doc-conventions 第 12 节。

3. 批次工作流标准清单

每个批次按以下链路执行(本清单是总索引,细则散见各规约;冲突以细则为准,发现清单过时须同批修订):

开工前

  1. 先检索后提问——先查在册记忆与权威文档,禁把已裁决事项当新问题重问或重踩在册坑
  2. 需求卡片全列备选案——每个待拍板点列全部备选方案与代价交用户裁决,禁卡片内自行定夺
  3. 用户发开工令才动手——需求卡片经用户批准(U0)后方开工

环境与基线 4. 代码面批独立 worktree+拷导入缓存——触及代码面的批次按 §1 建 worktree;先拷主区 .godot/ 目录与字体 .import 边车再跑测试,否则全量重导入资源近似卡死。检出工作区零测试,直接开工(2026-10-22 频率规则);闸壳每次跑批先自检/自愈本区 user 目录隔离(§1 第 1 条),建不起来即拒跑;直改车道(非代码面)无此项 5. 涉数值改动先采改前读数——与改后同随机种子配对比较并写明逐项比对口径;无数值改动禁跑模拟

实施 6. 新功能必配新测试——新增玩法/机制必须配套新测试套件进 tests/run_all;没有对应测试的变更不许合并;并按 test-conventions §8 挂进改动—验收对照表,没有对照表行的行为改动同样不许合并 7. 验收改动先行声明——验收变化(基线换代/探针增改/旧断言改判)预先写进需求卡片,禁事后补

完成 8. 批末按域验收才合并(worktree 批;直改车道无批末动作,验收在 commit 点由 git 钩子执行,见 §1 第 3 条)——在任务 worktree 内跑 tools/run_all_gates.sh,按本批改动域选档:按文件性质判——代码面=game/ 下非 .md 的行为载体(代码、测试脚本、探针、场景、数据表、素材)→ --code;文档件=game/ 内 .md(README、生成清单)与 game/ 外一切路径(design/、根规则文件、tools/ 工具脚本、.zcode/ 配置等)→ --docs;两类同批都有 → 全量档不带参数。所选域全绿才合回 master。合回前独立验收审计通过(iter 技能第 5 步),未过不合回。该脚本是全部验证闸的唯一入口、唯一清单与唯一域划分,闸件增减、分域调整都只改它;本文与其他文档禁另列闸件清单(清单散落多处正是 iter27 漏跑 probe_gate --full 的成因)。跑完写回执 game/tests/.gates/receipt.json(含 domain 与 dirty_game 字段),合回时由 worktree-guard 按 diff 文件性质推域强制校验(六况拦截:缺回执/quick 模式/回执未覆盖分支尖=回执 commit 之后代码面又有改动、或跑闸时代码面带着未提交改动(dirty_game)/域不覆盖本次改动/含新增红/master HEAD 非回执 commit 祖先=合并将产出未测内容)。回执与分支尖的对齐判据是代码面不是 commit 号:回执之后只追加文档件(game/ 内 .md、reports/、design/ 等)提交,回执照样有效,不构成复跑理由。闸件(tools/ 下机检脚本与闸壳)自身的改动不占合回全量——其质量义务=落批时人工确认闸可跑通且判据口径未变,闸真崩溃时合回闸 fail-closed(跑不出回执即拦),不以合回全量为兜底 9. 合并后主区零复跑(2026-10-24 用户裁:合回重跑验的是与回执同一份字节,零信息)——合回落地后 code 批只做两件秒级事:--editor --quit 重刷类名缓存(在册坑:.godot 缓存不入 git,与合并后代码失配会假红假绿)+冒烟启动确认可开机(合计约 1 分钟);docs 批零动作。全量验证每批跑一次=worktree 批末按域闸,顺序是「先并入 master、再跑闸」(§1 第 2 条);只有两种情形允许把这次跑作废重来——① 闸红且修法动了 game/,② 闸已开跑后 master 又被推进(合并将产出未测内容,由合回闸祖先判定拦下,§3.9 第六况)。「跑都跑了再跑一遍保险」「闸后顺手改点 game/ 再补一跑」都不构成复跑理由;master 上永不跑全量 10. 批次完成后的登记义务——合回 master 后按 doc-conventions §12.1 推进待办清单条目状态(做完整条删除),涉及迭代编排的在 roadmap 迭代总表与顶部「当前位」节换代——执行入口=项目技能 batch-closure(批后收尾与中间文档退役),跨会话教训写记忆库。批次过程与结论由 git 提交信息承载,禁止再写会话状态文件(见 doc-conventions 第 10 节)。design/ 与根规则文件(AGENTS.md/roadmap.md/待办清单.md/体验验证清单.md)实现批禁写,见 §12 11. 文档同步闸(实现批禁写文档)——实现批禁写 design/ 整个目录与根规则文件,要往外交代的东西一律落 reports/:实现报告 reports/iter<N>-实现报告-<日期>.md(各卡状态+实机目检总清单+遗留读数义务+实现决定记录——超白名单/超卡片明列范围事项逐条记「决了什么/为什么/代价/撤销方式」,全部按卡执行时只写一行「零拍板」)、GDD 反哺点清单 reports/iter<N>-反哺点-<日期>.md(每条写清哪个文件哪一节、改成什么、依据是什么)。设计权威文档(GDD/art-bible)任何批都不直改:用户在会话中逐点裁决后,由工程/文档设计改动批(直改类)写入 design/(执行入口=doc-design 技能),并把反哺条目从 reports/ 清掉(吸收即死;退役执行=batch-closure 技能)。机械面文档(roadmap 行/术语表/README 工具注)同样归工程/文档设计改动批在合并前更新。反哺点未落地期间相关 GDD 节视为待反哺,读前先查 reports/ 与待办清单;需求卡片必列「关联文档同步面」按两层标注 12. 实机目检归用户,只登记不阻塞——真人检测项登记进实现报告目检总清单与体验验证清单即完成批内义务;禁把等目检当停工理由或完成前置 13. 中间产物吸收即死——细则见 AGENTS.md 硬性红线与 doc-conventions 第 11 节 14. 改动级验收闭合——写卡期列需求侧对照表,实现期补实际对照表(测试文件:行),每个行为改动做撤销证明;合回前独立验收审计。细则=test-conventions §8

4. 测试执行两入口铁规(细则)

测试类执行——冒烟、单元测试(tests/run_all)、模拟验证(MC/verifier/调参批量工具)、场景探针等一切跑游戏的验证——只有两个触发入口:①迭代 loop 开发(冒烟挂迭代出口/入库闸,loop 内过程性验证属开发工作本身);②用户主动点名。其余会话(问答/调研/文档/审查/零散小改)一律零测试;确需测试支撑结论时先请示,以静态阅读/推理作答并注明未跑测。

MC/verifier 触发细则:仅在数值验证场景触发(改数值前后取证);normal 档为主、perfect 按需;无数值改动的会话禁跑 MC;结构位移类「存档锚」须先向用户请示定性再跑;需求卡片预设步骤的前提消失时(如「带值裁定后重锚」实际未投值)停问勿照字面执行。

分级周期口径:全部验证闸收编在 tools/run_all_gates.sh 一个入口下(脚本即清单,且即域划分的唯一出处),分三档——--code/--docs 按本批改动域只跑该域闸(闸件清单与域划分只写在脚本头部注释,本文不重列);--quick 是全量档的中段自检形态(跳过渲染闸与静态扫描);不带参数=两域全量,用于同一批既有代码面又有文档件改动。完成出库按所选域全绿,回执由合回闸按 diff 文件性质推域强制校验。真人实机目检归用户不进自动闸。

5. MC 采集档位细则

四档硬闸(全表与统计精度见 sim-data/README.md「MC 采集档位表」):

档 用途 上限 触发权
一档·调研 调研/数值分析 总量 >40 只能由用户发起——需求卡片/计划书/agent 均无权授权
二档·数值修改验证 改数值前后取证 总量 ≤40、每档 ≤20 数值验证场景
三档·小调 只测不判 总量 ≤20、每档 ≤10 数值验证场景
四档·微量 sanity 门,零统计判读 总量 ≤5 数值验证场景

配套纪律:超档=停机呈报,窗口不足如实挂起,禁在二/三/四档下带值结论;改前/改后锚同 seed0 配对、改前锚留盘禁补跑;逐项比对断言零新跑(复验用锚内子集 ≤20);读数缺陷(零 gameplay/RNG 触碰)禁整套重跑、走事件流重构补算;≥60 局采集先 N=5 pilot 校验字段;二/三/四档会话累计 ≤20 分钟;零数值改动=零 MC;四档仅承接数值验证场景,两入口铁规不变。

6. 闸机轮次纪律

  1. 孤立验证先行——新代码/新工具/新断言进全套闸之前,先走通最小可运行路径的 standalone 验证(30 秒级:新断言=单独驱动函数直跑;新工具=最小参数全路径试车含产出落盘;新探针=单 .tscn 直跑);禁以全套闸首跑充当新码首验
  2. 调试期最窄确认——出红→修复→确认只跑出红的最小单元(单探针/单套件/单函数);全套闸每个里程碑步(波/T 段)出口最多一次,红灯补跑只跑红件;修的是全部探针/套件共用的共享件(冒烟包装器、闸机脚本本身)时全套即最小充分单元,注记说明即可
  3. 长批试车——≥2 分钟的跑批(逐位逐项比对冻结/MC 批/批量模拟)发起前,先用最小参数把工具完整路径(含解析/落盘/写锚全链)跑通一遍再放长批
  4. 开工坑册扫描——每波/T 段开工前,按要触碰的面扫一遍在册坑(worktree 缓存三件套、--script 模式无 autoload、守卫文本匹配等)

7. 像素结构件工作纪律

  1. 先抄后造——画像素结构件前,先从参考素材裁同类结构放大逐像素描述,再实现同款;禁凭印象/第一性原理发明像素结构(art-bible §8.5 参考核验的执行口径)
  2. 验完成径写成像素级视觉判据——开工前把合格标准写成"X 与 Y 同列收尾/无悬空/无突出"式句子;自检放大最差交界处逐行核像素,不只看整板观感
  3. ±1px 一律坐标推导——单像素级结构先写坐标推导(哪条线在哪列、谁与谁齐平)留档再写码;禁蒙数试错
  4. 修复默认附前后对比图+像素审计,不等用户索要