Blacksite/docs/editor/debt-audit.md

2.5 KiB
Raw Permalink Blame History

Editor zero-debt audit checklist

Living checklist for the production editor program (ADR 0012). Update when closing a phase or removing debt.

Must not ship (gate before phase sign-off)

Item Status Notes
bevy_inspector_egui entity dump on default Inspector tab Done actor_inspector only; bevy-inspector-egui kept for SelectedEntities
Monolithic hydrate_authoring_entities Done crates/shared/src/hydration/* modules
Optional / inferred ActorKind as long-term save path Done Schema v2 + migration; save validates
Hydrated components in committed .scn.ron CI scene::validate_scene_authoring_only + repo_editor_scene_has_no_hydrated_components
Production mutation without commit/cancel/failure/undo invariants Done Shared operator harness plus typed history projections cover palette, asset, brush, terrain, physics, grouping, lighting, material-drop, and transform paths; see evaluation
Representative editor coverage can silently disappear Done Versioned five-area manifest, typed scene gate, validate-samples, and native protocol; see sample pack
Dual FBX thumbnail ad-hoc path (parallel to unified pipeline) Partial Phase 5 assets/thumbnails/ refactor
failed_keys thumbnail cache without retry API Partial asset_thumbnails.rs; Phase 5 ThumbnailState

Phase completion gates

Phase Debt gate
P0 Hydration modules; strip-on-save tests; live project lighting
P1 ActorKind required; validate_actor on save
P2 No runtime components in default inspector
P3 HierarchySiblingIndex; no undefined sibling order
P6 ActorInspectorSection registry; typed immediate/modal command dispatch; BRP authoring policy; production mutation invariants
P7 ADRs 00090012 indexed; CI shared + scene + editor checks

Manual verification (release)

  • R1R6 rendering/inspector scenarios (roadmap.md)
  • Save/load roundtrip: hierarchy, lights, materials unchanged
  • PIE 60s stop: project lighting profile unchanged unless scene overrides edited
  • Rerun the operator invariant matrix from the nominated release-candidate commit
  • Open all five sample regression pack entries through the native File menu and record exact-candidate results