docs: add standing GUI-testing guidelines and scenario library#883
Merged
lklimek merged 1 commit intoJul 13, 2026
Merged
Conversation
Introduces docs/gui-testing/ as a reusable-across-sessions home for guidance on driving the real compiled app through a real display -- a tier not covered by kittest (no display) or backend-e2e (no UI). Deliberately not date-grouped under docs/ai-design, unlike point-in-time design docs, since this is standing practice agents should discover on every future GUI-verification task, not a historical record. Covers: when to use this tier vs kittest/backend-e2e, safety rules (isolated data dir, never touch a running instance, credential handling, fund-movement caps, preferring consensus-forced destinations), and a scenario file template. CLAUDE.md now points here from both the Testing and Documentation sections so agents find it before running a live GUI test. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Contributor
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. 🗂️ Base branches to auto review (2)
Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
cdd5a70
into
docs/platform-wallet-migration-design
1 check passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why this PR exists
kittest(in-process harness, no display) andbackend-e2e(callsBackendTasks directly, no UI) — but there's no standing home for the guidance and safety rules that kind of testing needs, so every agent/session re-derives them from scratch (launch recipe, credential handling, fund-movement safety, isolated-data-dir discipline).docs/platform-wallet-migration-design(feat: platform-wallet backend rewrite (spec + implementation) #860) since that's the current active integration branch.What was done
docs/gui-testing/README.md: when to reach for this tier vs.kittest/backend-e2e, non-negotiable safety rules (isolated data dir, never touch an already-running instance, credential handling by env-var name only — never hardcode secrets, testnet-by-default, capped fund movement, prefer consensus-forced destinations, always check logs for a panic even when the UI looked fine), and the scenario file format/index.docs/gui-testing/scenarios/TEMPLATE.md: the template for individual scenario files, written at the level of "what to look for" rather than pixel coordinates so scenarios survive minor UI changes.CLAUDE.md: two new pointers — one under Testing (agents about to run a live GUI test find it), one under Documentation (consistent with howdocs/ai-design,docs/personas, etc. are catalogued). Deliberately not date-grouped underdocs/ai-design— this is standing, reusable practice meant to be discovered on every future GUI-verification task, not a point-in-time design record.Testing
Documentation-only change — no code paths affected.
cargo fmt/clippy/tests unaffected (verified no source files touched).Breaking changes
None.
Checklist
Attribution
🤖 Co-authored by Claudius the Magnificent AI Agent