Skip to content

Commit cb90916

Browse files
committed
docs: capture cross-platform guidance
1 parent cc53f59 commit cb90916

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,12 @@ CLI input
118118
- For CLI, config, or pager work: make sure the relevant source invocation still works (`diff`, `show`, `patch`, or `pager`).
119119
- Preserve current interaction model unless the user asks to change it explicitly.
120120

121+
## cross-platform support
122+
123+
- Hunk should work on macOS, Linux, and Windows. Keep tests and CI portable unless a case is explicitly Unix-only (PTY/TTY smoke coverage is Unix-only).
124+
- In tests, avoid hard-coded POSIX paths, separators, shell syntax, and filenames invalid on Windows; use Node path helpers for real filesystem paths while preserving user-provided/protocol paths when pass-through is intentional.
125+
- If Windows-only Bun behavior appears around timers, sockets, or line endings, prefer a small compatibility fix or a narrowly scoped skip with a comment over broadening Unix assumptions.
126+
121127
## releases
122128

123129
- Maintain the top-level `CHANGELOG.md` as the source of truth for user-visible changes.

0 commit comments

Comments
 (0)