From 09416de0cde5489956288b4cd788cb89786c45af Mon Sep 17 00:00:00 2001 From: SathishM Date: Thu, 22 Oct 2026 22:58:46 +0530 Subject: [PATCH] docs(testing): note Windows source-checkout suite expectations (#6323) Document that the general source suite runs on Linux in CI and that Windows CI selects a curated lane, so Windows contributors compare failures against the base revision instead of attributing POSIX-only failures to their change. Fixes #6308 --- CONTRIBUTING.md | 8 ++++++++ docs/testing.md | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4d8b7260b4..6627ed08e8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -239,6 +239,14 @@ MinGW-w64, and `tar`; the build script does not run on Windows. See that guide for the build and artifact-verification commands and the separate real Windows verification prerequisites. Keep the generated addon and manifest uncommitted. +The general source suite (`npm run test:fast`, `npm run test:changed`, and +`npm run test:local`) runs on Linux in CI, and Windows CI runs a curated lane. +On a Windows checkout, some source tests fail because fixtures use POSIX paths, +`#!/bin/sh` tool stubs, or POSIX rename semantics. Compare failures against the +base revision, or run the suite on Linux or WSL, before attributing them to a +change. See [testing](docs/testing.md#developer-commands) for command scopes +and lane selection. + ## Documentation website The VitePress site uses the Markdown files in `docs/`. Run `npm run docs:dev` diff --git a/docs/testing.md b/docs/testing.md index 92aee89458..7ff6fbd079 100644 --- a/docs/testing.md +++ b/docs/testing.md @@ -26,6 +26,14 @@ behavior, and complete CI evidence before merging. | `npm run check:pr` | Opt-in complete local deterministic gate and generated-file checks | | `npm run docs:check` | Generated-document validation and fresh onboarding example consistency checks | +The general source suite above runs on Linux in CI, and Windows CI runs a +curated lane ([Native platform baseline in CI](#native-platform-baseline-in-ci)). +A Windows source checkout can fail source tests for reasons unrelated to the +change, such as POSIX fixture paths, `#!/bin/sh` tool stubs, or POSIX rename +semantics. Compare failures against the base revision, or run the suite on +Linux or WSL, before attributing them to a change. See `CONTRIBUTING.md` → +Windows source checkouts. + For example: ```bash