Skip to content

cross-platform-guidelines.md

Latest commit

 

History

History
23 lines (19 loc) · 1.01 KB

cross-platform-guidelines.md

File metadata and controls

23 lines (19 loc) · 1.01 KB
Raw

SC-Compose Cross-Platform Guidelines

Required Rules

  1. Do not hardcode /tmp in production code or tests.
  2. Use std::env::temp_dir() or tempfile::TempDir for temporary paths.
  3. Do not set HOME or USERPROFILE directly in tests unless the test is explicitly about home-directory resolution.
  4. Prefer repo-specific env vars such as SC_COMPOSE_* over ambient OS-home mutation.
  5. Use PathBuf and .join() for path construction.
  6. Do not assume Unix-only socket, path, or executable behavior unless the code is cfg-gated accordingly.
  7. Keep the documented Rust toolchain floor consistent across workspace files. The current workspace minimum is Rust 1.94.1 because sc-observability 1.0.0 is part of the release dependency set.

Test Rules

  1. Tests must isolate filesystem state in temporary directories.
  2. Tests must not rely on platform-specific default paths when explicit test paths can be provided.
  3. Tests that spawn subprocesses must use bounded waits and explicit teardown.