[PR #6323] [MERGED] docs(testing): note Windows source-checkout suite expectations #7283

Closed
opened 2026-11-01 21:46:44 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/6323
Author: @sathish123m
Created: 10/22/2026
Status: ✅ Merged
Merged: 10/22/2026
Merged by: @morluto

Base: main ← Head: docs/windows-source-suite-expectations


📝 Commits (1)

  • 8281183 docs(testing): note Windows source-checkout suite expectations

📊 Changes

2 files changed (+16 additions, -0 deletions)

View changed files

📝 CONTRIBUTING.md (+8 -0)
📝 docs/testing.md (+8 -0)

📄 Description

Summary

Fixes #6308. Document that the general source suite (npm run test:fast,
npm run test:changed, and npm run test:local) runs on Linux in CI and that
Windows CI selects a curated lane, so a Windows source checkout is not expected
to pass the general suite unchanged.

Problem and expected behavior

CONTRIBUTING.md → "Windows source checkouts" explains that the native addon is
missing from a source checkout, but not that the general source suite is not
expected to pass on Windows. Issue #6308 reports 98 failed / 13,957 passed tests
on a clean Windows 11 checkout (npm ci of main, Node 24.18.0), with the same
change-independent failures on earlier base revisions and none on Linux.
Without that expectation documented, a Windows contributor cannot tell whether
failures come from the change or from POSIX-only test assumptions.

Change and scope

  • CONTRIBUTING.md: add a short paragraph to "Windows source checkouts" stating
    the Linux / curated-Windows-lane expectation and how to attribute failures.
  • docs/testing.md: state the same expectation above the developer-command
    examples and link the existing "Native platform baseline in CI" section.

Intentionally not included: making the affected tests portable or skipping them
on win32. Issue #6308 notes that would also resolve the report, but it is a
separate decision; this change documents the current expectation only.

Contract and boundary impact

  • Semantic owner and earliest changed stage: documentation only.
  • Contribution scope fit and linked maintainer decision: documentation-only
    clarification; no scope decision needed.
  • CLI and MCP/tool-catalog contract: none.
  • Provider, bridge, target-format, or platform compatibility: documents existing
    Windows CI lane selection; no behavior change.
  • Evidence, artifact, provenance, or reconstruction contract: none.
  • Target selection, authority, upstream behavior, and cleanup details: not
    applicable.
  • Generated metadata (docs/public/product-catalog.json), package, or
    installation impact: none.

Expected effects (check known effects; use documentation-only on its own).

  • Documentation or usability only; no target interaction.

Evidence and regression coverage

  • Tests added or updated: none (documentation-only).
  • Base reproduction or other evidence: issue #6308 — 98 failed / 13,957 passed
    on Windows 11 (Node 24.18.0), reproduced on two earlier base revisions and
    absent on Linux.
  • User-visible CLI/MCP output (if applicable): not applicable.
  • Remaining proof gaps: this records the current expectation; it does not
    establish that every failing file is intentionally POSIX-only.

Validation performed

  • npm run docs:check — passed (6 tasks; readme consistency 9/9 tests).
  • npx oxfmt --check CONTRIBUTING.md docs/testing.md — passed.
  • npm run docs:build — fails on the same 7 pre-existing dead links
    (experiments/analysis-efficiency/...) with and without this change; this
    change adds none.

Compatibility, safety, and release

  • Breaking changes or migration steps: none.
  • Real Hopper/Ghidra, browser, or OS coverage: not applicable; the linked issue
    evidence is from the reporter's Windows host.
  • Package or release metadata impact: none.
  • Security, privacy, process, or containment review: none — documentation only.

Author readiness

Human owner: @sathish123m

  • I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work.
  • I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps.
  • I declare this PR ready for initial maintainer review.

Before merge

  • This PR addresses a concrete problem or an agreed enhancement.
  • Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff.
  • The PR has one focused outcome and the title follows type(scope): outcome.
  • Related issue is linked, or the reason for not linking one is stated above.
  • Tests cover changed observable behavior and meaningful failure paths.
  • Owning docs, contracts, and generated metadata are updated where needed.
  • User-visible CLI/MCP changes include representative output.
  • I checked the final diff for secrets, unrelated cleanup, and unsupported claims.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/6323 **Author:** [@sathish123m](https://github.com/sathish123m) **Created:** 10/22/2026 **Status:** ✅ Merged **Merged:** 10/22/2026 **Merged by:** [@morluto](https://github.com/morluto) **Base:** `main` ← **Head:** `docs/windows-source-suite-expectations` --- ### 📝 Commits (1) - [`8281183`](https://github.com/morluto/rea/commit/8281183ccd7d92e1fde0003b1644b726b264936b) docs(testing): note Windows source-checkout suite expectations ### 📊 Changes **2 files changed** (+16 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `CONTRIBUTING.md` (+8 -0) 📝 `docs/testing.md` (+8 -0) </details> ### 📄 Description ## Summary Fixes #6308. Document that the general source suite (`npm run test:fast`, `npm run test:changed`, and `npm run test:local`) runs on Linux in CI and that Windows CI selects a curated lane, so a Windows source checkout is not expected to pass the general suite unchanged. ## Problem and expected behavior `CONTRIBUTING.md` → "Windows source checkouts" explains that the native addon is missing from a source checkout, but not that the general source suite is not expected to pass on Windows. Issue #6308 reports 98 failed / 13,957 passed tests on a clean Windows 11 checkout (`npm ci` of `main`, Node 24.18.0), with the same change-independent failures on earlier base revisions and none on Linux. Without that expectation documented, a Windows contributor cannot tell whether failures come from the change or from POSIX-only test assumptions. ## Change and scope - `CONTRIBUTING.md`: add a short paragraph to "Windows source checkouts" stating the Linux / curated-Windows-lane expectation and how to attribute failures. - `docs/testing.md`: state the same expectation above the developer-command examples and link the existing "Native platform baseline in CI" section. Intentionally not included: making the affected tests portable or skipping them on `win32`. Issue #6308 notes that would also resolve the report, but it is a separate decision; this change documents the current expectation only. ## Contract and boundary impact - Semantic owner and earliest changed stage: documentation only. - Contribution scope fit and linked maintainer decision: documentation-only clarification; no scope decision needed. - CLI and MCP/tool-catalog contract: none. - Provider, bridge, target-format, or platform compatibility: documents existing Windows CI lane selection; no behavior change. - Evidence, artifact, provenance, or reconstruction contract: none. - Target selection, authority, upstream behavior, and cleanup details: not applicable. - Generated metadata (`docs/public/product-catalog.json`), package, or installation impact: none. Expected effects (check known effects; use documentation-only on its own). - [x] Documentation or usability only; no target interaction. ## Evidence and regression coverage - Tests added or updated: none (documentation-only). - Base reproduction or other evidence: issue #6308 — 98 failed / 13,957 passed on Windows 11 (Node 24.18.0), reproduced on two earlier base revisions and absent on Linux. - User-visible CLI/MCP output (if applicable): not applicable. - Remaining proof gaps: this records the current expectation; it does not establish that every failing file is intentionally POSIX-only. ## Validation performed - `npm run docs:check` — passed (6 tasks; readme consistency 9/9 tests). - `npx oxfmt --check CONTRIBUTING.md docs/testing.md` — passed. - `npm run docs:build` — fails on the same 7 pre-existing dead links (`experiments/analysis-efficiency/...`) with and without this change; this change adds none. ## Compatibility, safety, and release - Breaking changes or migration steps: none. - Real Hopper/Ghidra, browser, or OS coverage: not applicable; the linked issue evidence is from the reporter's Windows host. - Package or release metadata impact: none. - Security, privacy, process, or containment review: none — documentation only. ## Author readiness Human owner: @sathish123m - [x] I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work. - [x] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [x] I declare this PR ready for initial maintainer review. ## Before merge - [x] This PR addresses a concrete problem or an agreed enhancement. - [x] Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff. - [x] The PR has one focused outcome and the title follows `type(scope): outcome`. - [x] Related issue is linked, or the reason for not linking one is stated above. - [x] Tests cover changed observable behavior and meaningful failure paths. - [x] Owning docs, contracts, and generated metadata are updated where needed. - [x] User-visible CLI/MCP changes include representative output. - [x] I checked the final diff for secrets, unrelated cleanup, and unsupported claims. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
bsakaguchi 2026-11-01 21:46:44 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
morluto/rea#7283
No description provided.