forked from openai/codex
-
Notifications
You must be signed in to change notification settings - Fork 0
[Usability] Add contributor guide for updating TUI insta snapshots #46
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationusabilityUser experience and ergonomicsUser experience and ergonomics
Description
Summary
Contributors often hit failing snapshot tests in codex-rs/tui. Add a concise guide to list, review, and accept insta updates.
Current vs Expected
- Current: No single contributor‑facing doc with
cargo instacommands. - Expected: A short section under Contributing covering: run tests, view pending, review specific
*.snap.new, accept intentionally, installcargo-instaif needed.
Proposed Changes
- Add a subsection to docs/contributing.md or a new docs/testing.md covering:
cargo test -p codex-tuicargo insta pending-snapshots -p codex-tuicargo insta show -p codex-tui path/to/file.snap.newcargo insta accept -p codex-tui
- Link from codex-rs/tui/README or codex-rs/README.
Acceptance Criteria
- Contributor doc exists and links are discoverable from README.
- Commands verified locally.
References
- codex-rs/tui (snapshot tests via insta)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationusabilityUser experience and ergonomicsUser experience and ergonomics