From 7f0588fb979e011b7b4e6e51ecee3a43f0b140f0 Mon Sep 17 00:00:00 2001 From: wan9chi Date: Sat, 11 Jul 2026 10:17:55 +0800 Subject: [PATCH] docs: allow musl-specific test skips Co-authored-by: GPT-5 Codex --- CLAUDE.md | 4 ++-- CONTRIBUTING.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 09c23223d..c394e67ea 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -67,7 +67,7 @@ The test suite has no known pre-existing failures or flaky tests. If a test fail ### Cross-Platform Testing -**CRITICAL**: This project must work on both Unix (macOS/Linux) and Windows. Skipping tests on either platform is **UNACCEPTABLE**. +**CRITICAL**: This project must work on both Unix (macOS/Linux) and Windows. Skipping tests on either platform is **UNACCEPTABLE**, except on musl targets when an essential dependency or required platform capability is unavailable. Document the unavailable requirement and keep the skip scoped to musl. - Use `#[cfg(unix)]` and `#[cfg(windows)]` for platform-specific code within tests - Both platforms must execute the test and verify the feature works correctly @@ -146,7 +146,7 @@ Enforced by `.clippy.toml`: ### Cross-Platform Requirements -All code must work on both Unix and Windows without platform skipping: +All code must work on both Unix and Windows without platform skipping. The only exception is for tests on musl targets when an essential dependency or required platform capability is unavailable; document the reason and scope the skip to musl. - Use `#[cfg(unix)]` / `#[cfg(windows)]` for platform-specific implementations - Platform differences should be handled gracefully, not skipped diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cf998d029..c7bd293d3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -78,7 +78,7 @@ See `playground/README.md` for the full task list and dependency structure. ## Cross-Platform Development -This project must work on macOS, Linux, and Windows. Skipping tests on any platform is not acceptable. +This project must work on macOS, Linux, and Windows. Skipping tests on any platform is not acceptable, except on musl targets when an essential dependency or required platform capability is unavailable. Document the unavailable requirement and keep the skip scoped to musl. - Use `#[cfg(unix)]` / `#[cfg(windows)]` for platform-specific code - Use cross-platform libraries where possible (e.g., `terminal_size` instead of raw ioctl/ConPTY)