[PR #6322] [CLOSED] docs: state that the general source suite is not expected to pass on Windows #7282

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/6322
Author: @wanjinhao1
Created: 10/22/2026
Status: ❌ Closed

Base: main ← Head: agent/docs-6308-windows-suite


📝 Commits (1)

  • eb742f8 docs: state that the general source suite is not expected to pass on Windows (Fixes #6308)

📊 Changes

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

View changed files

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

📄 Description

Summary

Fixes #6308

CONTRIBUTING.md's "Windows source checkouts" section explains that the native addon is missing from a source checkout, but not that the general source suite (npm run test:fast, test:changed, test:local) is not expected to pass on Windows: CI runs that suite on Linux and only a curated lane on Windows. A Windows contributor cannot tell that these failures are expected and change-independent.

Problem and expected behavior

A Windows checkout of main shows 98 failures across 26 files in the general source suite (POSIX fixture paths, #!/bin/sh tool stubs, POSIX rename semantics, host-specific expectations), reproduced on the base revision without any change. Previously the docs said nothing about this, so a Windows contributor could reasonably attribute those failures to their change. Expected: the docs state the Linux expectation and what to do (compare against the base revision, or run on Linux/WSL).

Change and scope

Documentation-only: add one paragraph to CONTRIBUTING.md ("Windows source checkouts") and one note after the developer-commands table in docs/testing.md pointing at that section. No code, CI, or test changes; making the tests portable is intentionally out of scope for this documentation report.

Follow the contribution scope. Not applicable: documentation-only change, no new capability.

Contract and boundary impact

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

Expected effects:

  • Read existing files or captured data.
  • Launch or attach to a process.
  • Inject instrumentation or run scripts/code.
  • Change process memory, registers, files, or configuration.
  • Contact network services.
  • Recover protected code or work around protections.
  • Documentation or usability only; no target interaction.
  • Not sure yet; investigation or maintainer guidance needed.

Evidence and regression coverage

  • Tests added or updated: none (documentation-only change)
  • Base reproduction or other evidence: the issue body documents the 98 failures across 26 files on Windows main at 31dc03504 (and 57 failures in 14 files on an earlier base), all change-independent; Linux test:changed on the same branch showed none of these failures
  • User-visible CLI/MCP output: not applicable
  • Remaining proof gaps: whether every one of the 26 files is intentionally POSIX-only was not established in the issue (noted there)

Documentation-only checks: verified the referenced section heading exists in CONTRIBUTING.md, the relative link ../CONTRIBUTING.md resolves from docs/testing.md (same pattern as the existing ../experiments/... links), and the command names match the developer-commands table in docs/testing.md.

Validation performed

  • Manual review of rendered Markdown diff — content and links verified as above
  • No test suite run — documentation-only change; the repo's docs checks require a full npm ci which was not run locally; CI will run the docs lanes

Compatibility, safety, and release

  • Breaking changes or migration steps: none
  • Real Hopper/Ghidra, browser, or OS coverage: not applicable
  • Package or release metadata impact: none
  • Security, privacy, process, or containment review: none

Author readiness

Human owner: @wanjinhao1

Per the contribution policy, the AI agent leaves these declarations to the human owner to confirm (draft PR; the owner will check them before requesting review):

  • 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. (docs-only; no observable behavior change)
  • Owning docs, contracts, and generated metadata are updated where needed.
  • User-visible CLI/MCP changes include representative output. (not applicable)
  • I checked the final diff for secrets, unrelated cleanup, and unsupported claims.

AI assistance disclosure: this PR was prepared with AI assistance on behalf of @wanjinhao1 (the human owner of this PR), following the repository's AI-assisted contribution policy.


🔄 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/6322 **Author:** [@wanjinhao1](https://github.com/wanjinhao1) **Created:** 10/22/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `agent/docs-6308-windows-suite` --- ### 📝 Commits (1) - [`eb742f8`](https://github.com/morluto/rea/commit/eb742f80ef57031db39f86782e8f770428c86377) docs: state that the general source suite is not expected to pass on Windows (Fixes #6308) ### 📊 Changes **2 files changed** (+15 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `CONTRIBUTING.md` (+8 -0) 📝 `docs/testing.md` (+7 -0) </details> ### 📄 Description ## Summary Fixes #6308 `CONTRIBUTING.md`'s "Windows source checkouts" section explains that the native addon is missing from a source checkout, but not that the general source suite (`npm run test:fast`, `test:changed`, `test:local`) is not expected to pass on Windows: CI runs that suite on Linux and only a curated lane on Windows. A Windows contributor cannot tell that these failures are expected and change-independent. ## Problem and expected behavior A Windows checkout of `main` shows 98 failures across 26 files in the general source suite (POSIX fixture paths, `#!/bin/sh` tool stubs, POSIX rename semantics, host-specific expectations), reproduced on the base revision without any change. Previously the docs said nothing about this, so a Windows contributor could reasonably attribute those failures to their change. Expected: the docs state the Linux expectation and what to do (compare against the base revision, or run on Linux/WSL). ## Change and scope Documentation-only: add one paragraph to `CONTRIBUTING.md` ("Windows source checkouts") and one note after the developer-commands table in `docs/testing.md` pointing at that section. No code, CI, or test changes; making the tests portable is intentionally out of scope for this documentation report. Follow the [contribution scope](https://github.com/morluto/rea/blob/main/CONTRIBUTING.md#contribution-scope). Not applicable: documentation-only change, no new capability. ## Contract and boundary impact - Semantic owner and earliest changed stage: none (documentation only) - Contribution scope fit and linked maintainer decision: not applicable (docs-only) - CLI and MCP/tool-catalog contract: none - Provider, bridge, target-format, or platform compatibility: none (documents existing platform behavior) - Evidence, artifact, provenance, or reconstruction contract: none - Target selection, authority, upstream behavior, and cleanup details: not applicable - Generated metadata, package, or installation impact: none Expected effects: - [ ] Read existing files or captured data. - [ ] Launch or attach to a process. - [ ] Inject instrumentation or run scripts/code. - [ ] Change process memory, registers, files, or configuration. - [ ] Contact network services. - [ ] Recover protected code or work around protections. - [x] Documentation or usability only; no target interaction. - [ ] Not sure yet; investigation or maintainer guidance needed. ## Evidence and regression coverage - Tests added or updated: none (documentation-only change) - Base reproduction or other evidence: the issue body documents the 98 failures across 26 files on Windows `main` at 31dc03504 (and 57 failures in 14 files on an earlier base), all change-independent; Linux `test:changed` on the same branch showed none of these failures - User-visible CLI/MCP output: not applicable - Remaining proof gaps: whether every one of the 26 files is intentionally POSIX-only was not established in the issue (noted there) Documentation-only checks: verified the referenced section heading exists in `CONTRIBUTING.md`, the relative link `../CONTRIBUTING.md` resolves from `docs/testing.md` (same pattern as the existing `../experiments/...` links), and the command names match the developer-commands table in `docs/testing.md`. ## Validation performed - Manual review of rendered Markdown diff — content and links verified as above - No test suite run — documentation-only change; the repo's docs checks require a full `npm ci` which was not run locally; CI will run the docs lanes ## Compatibility, safety, and release - Breaking changes or migration steps: none - Real Hopper/Ghidra, browser, or OS coverage: not applicable - Package or release metadata impact: none - Security, privacy, process, or containment review: none ## Author readiness Human owner: @wanjinhao1 Per the contribution policy, the AI agent leaves these declarations to the human owner to confirm (draft PR; the owner will check them before requesting review): - [ ] 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 - [x] 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. - [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. (docs-only; no observable behavior change) - [x] Owning docs, contracts, and generated metadata are updated where needed. - [x] User-visible CLI/MCP changes include representative output. (not applicable) - [x] I checked the final diff for secrets, unrelated cleanup, and unsupported claims. --- **AI assistance disclosure**: this PR was prepared with AI assistance on behalf of @wanjinhao1 (the human owner of this PR), following the repository's AI-assisted contribution policy. --- <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#7282
No description provided.