-
Notifications
You must be signed in to change notification settings - Fork 5
docs: add a reusable terminal smoke-test checklist #255
Copy link
Copy link
Open
Labels
area:docsDocumentation, examples, and project guidanceDocumentation, examples, and project guidancedocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is neededpriority:p2Normal priority workNormal priority workstatus:acceptedAccepted and ready for implementationAccepted and ready for implementation
Description
Metadata
Metadata
Assignees
Labels
area:docsDocumentation, examples, and project guidanceDocumentation, examples, and project guidancedocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is neededpriority:p2Normal priority workNormal priority workstatus:acceptedAccepted and ready for implementationAccepted and ready for implementation
Problem
Terminal compatibility reports are most useful when they capture the same launch, input, resize, mouse, copy, and shutdown evidence. Today contributors have no reusable smoke-test checklist, so reports are difficult to compare across Windows, Linux, macOS, terminals, shells, and multiplexers.
Requested behavior
Add
docs/TERMINAL_SMOKE_TEST.mdwith a concise manual checklist and a copyable report template. Link it fromCONTRIBUTING.mdand use it to record one real terminal/OS test result in the pull request description.Likely files
docs/TERMINAL_SMOKE_TEST.md(new)CONTRIBUTING.mdAcceptance checks
Validation
git diff --check.Scope and mentoring
Expected size: small, documentation plus one manual test. No Rust changes are required. Comment with the OS and terminal you can test; the maintainer will help distinguish expected limitations from bugs.