[PR #2295] [MERGED] docs(contributing): explain Windows native prerequisites for source checkouts #5147

Closed
opened 2026-10-31 01:04:20 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/2295
Author: @jcamargos
Created: 10/12/2026
Status: ✅ Merged
Merged: 10/13/2026
Merged by: @morluto

Base: main ← Head: codex/windows-source-prerequisites


📝 Commits (1)

  • 55188d4 docs(contributing): explain Windows native prerequisites for source checkouts

📊 Changes

1 file changed (+15 additions, -0 deletions)

View changed files

📝 CONTRIBUTING.md (+15 -0)

📄 Description

Summary

Explain the Windows native artifact prerequisite in CONTRIBUTING.md and link to the canonical build guide. No related documentation issue was found; #2084 supplies a related report of missing checkout artifacts, not a bug this documentation change fixes.

Problem and expected behavior

The development setup describes npm ci and build:cached without explaining that a source checkout lacks the Windows native addon and manifest. Contributors can complete the runtime build while Windows workflows and tests requiring native controls remain unavailable. The setup guide should distinguish source checkouts from the published npm package before contributors try those workflows.

Change and scope

Add one Windows source checkouts subsection to CONTRIBUTING.md. Name the ignored artifacts, explain that the dependency/runtime build commands do not produce them, and link to native/windows/README.md#build for the existing Linux/MinGW-w64 build and verification instructions. No duplicated command recipe or new artifact acquisition mechanism.

Contract and boundary impact

  • Semantic owner and earliest changed stage: contributor development documentation.
  • Contribution scope fit and linked maintainer decision: ordinary documentation within existing boundaries; a separate advance scope decision is not applicable.
  • CLI and MCP/tool-catalog contract: none.
  • Provider, bridge, target-format, or platform compatibility: none; existing requirements are documented.
  • 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:

  • Documentation or usability only; no target interaction.

Evidence and regression coverage

  • Tests added or updated: none; documentation only.
  • Source-derived evidence, revalidated at f941968eb1: native/windows/README.md describes the separate artifact lane; .gitignore excludes build/; package.json and turbo.json keep the native build separate from dependency preparation and runtime/skill builds; scripts/build-windows-native.mjs rejects non-Linux hosts; src/windows/WindowsNativeLoader.ts reads the manifest and addon from native/windows/build/.
  • Related external report: https://github.com/morluto/rea/pull/2084 reports a missing manifest in a development checkout. Its runtime results were not reproduced for this change.
  • User-visible CLI/MCP output: not applicable; no runtime change.
  • Remaining proof gaps: no native-addon build, full test suite, or real-provider verification was executed. The published npm tarball was not downloaded or independently inspected. Windows-host static/build/documentation checks do not establish native-control runtime behavior.

Validation performed

  • git diff --check: passed.

  • git apply --reverse --check ../windows-source-prerequisites.patch: passed against the edited checkout.

  • git ls-files --eol CONTRIBUTING.md: LF in index and working tree, matching .gitattributes.

  • Static review: the new relative link resolves to the existing Build heading; only CONTRIBUTING.md changes, with 15 added lines; no generated artifacts or dependencies were added.

  • Windows x64, Node 24.18.0 / npm 11.16.0 (repository-pinned toolchain).

  • npm ci --ignore-scripts --no-audit --no-fund: passed; 400 packages installed without lifecycle scripts.

  • npm run check: passed, including typecheck, compile, lint, format, knip, metadata and architecture guards. Lint reported zero errors and 915 warnings in unchanged source; bundling reported two ineffective-dynamic-import warnings.

  • npm run docs:check: passed, including both README consistency tests (2/2). The managed-evidence generator reports complete:false; this check validates its representation and does not establish complete provider conformance.

  • The first sandboxed check could not spawn a child process (EPERM); the subsequent execution with subprocess permission passed. The Windows command wrapper also emits Node DEP0190; no command-wrapper code is changed here.

Compatibility, safety, and release

  • Breaking changes or migration steps: none.
  • Real Hopper/Ghidra, browser, or OS coverage: none claimed.
  • Package or release metadata impact: none.
  • Security, privacy, process, or containment review: documentation only; existing native admission requirements are preserved.

Before merge

  • This PR addresses a concrete documentation gap.
  • Scope is limited to existing documented behavior.
  • The PR has one focused outcome and a Conventional Commit title.
  • Related evidence is linked; no issue closure is claimed.
  • Required executable validation has completed for this documentation-only change.
  • Owning documentation is updated; no generated metadata needs editing.
  • CLI/MCP output is not applicable.
  • The final diff was reviewed for secrets, unrelated changes, 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/2295 **Author:** [@jcamargos](https://github.com/jcamargos) **Created:** 10/12/2026 **Status:** ✅ Merged **Merged:** 10/13/2026 **Merged by:** [@morluto](https://github.com/morluto) **Base:** `main` ← **Head:** `codex/windows-source-prerequisites` --- ### 📝 Commits (1) - [`55188d4`](https://github.com/morluto/rea/commit/55188d4e41e912a9d110605bb2dab52bf19d24d4) docs(contributing): explain Windows native prerequisites for source checkouts ### 📊 Changes **1 file changed** (+15 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `CONTRIBUTING.md` (+15 -0) </details> ### 📄 Description ## Summary Explain the Windows native artifact prerequisite in CONTRIBUTING.md and link to the canonical build guide. No related documentation issue was found; #2084 supplies a related report of missing checkout artifacts, not a bug this documentation change fixes. ## Problem and expected behavior The development setup describes npm ci and build:cached without explaining that a source checkout lacks the Windows native addon and manifest. Contributors can complete the runtime build while Windows workflows and tests requiring native controls remain unavailable. The setup guide should distinguish source checkouts from the published npm package before contributors try those workflows. ## Change and scope Add one Windows source checkouts subsection to CONTRIBUTING.md. Name the ignored artifacts, explain that the dependency/runtime build commands do not produce them, and link to native/windows/README.md#build for the existing Linux/MinGW-w64 build and verification instructions. No duplicated command recipe or new artifact acquisition mechanism. ## Contract and boundary impact - Semantic owner and earliest changed stage: contributor development documentation. - Contribution scope fit and linked maintainer decision: ordinary documentation within existing boundaries; a separate advance scope decision is not applicable. - CLI and MCP/tool-catalog contract: none. - Provider, bridge, target-format, or platform compatibility: none; existing requirements are documented. - 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: - [x] Documentation or usability only; no target interaction. ## Evidence and regression coverage - Tests added or updated: none; documentation only. - Source-derived evidence, revalidated at f941968eb1860dd41efc2a5201b35cecca42301d: native/windows/README.md describes the separate artifact lane; .gitignore excludes build/; package.json and turbo.json keep the native build separate from dependency preparation and runtime/skill builds; scripts/build-windows-native.mjs rejects non-Linux hosts; src/windows/WindowsNativeLoader.ts reads the manifest and addon from native/windows/build/. - Related external report: https://github.com/morluto/rea/pull/2084 reports a missing manifest in a development checkout. Its runtime results were not reproduced for this change. - User-visible CLI/MCP output: not applicable; no runtime change. - Remaining proof gaps: no native-addon build, full test suite, or real-provider verification was executed. The published npm tarball was not downloaded or independently inspected. Windows-host static/build/documentation checks do not establish native-control runtime behavior. ## Validation performed - git diff --check: passed. - git apply --reverse --check ../windows-source-prerequisites.patch: passed against the edited checkout. - git ls-files --eol CONTRIBUTING.md: LF in index and working tree, matching .gitattributes. - Static review: the new relative link resolves to the existing Build heading; only CONTRIBUTING.md changes, with 15 added lines; no generated artifacts or dependencies were added. - Windows x64, Node 24.18.0 / npm 11.16.0 (repository-pinned toolchain). - npm ci --ignore-scripts --no-audit --no-fund: passed; 400 packages installed without lifecycle scripts. - npm run check: passed, including typecheck, compile, lint, format, knip, metadata and architecture guards. Lint reported zero errors and 915 warnings in unchanged source; bundling reported two ineffective-dynamic-import warnings. - npm run docs:check: passed, including both README consistency tests (2/2). The managed-evidence generator reports complete:false; this check validates its representation and does not establish complete provider conformance. - The first sandboxed check could not spawn a child process (EPERM); the subsequent execution with subprocess permission passed. The Windows command wrapper also emits Node DEP0190; no command-wrapper code is changed here. ## Compatibility, safety, and release - Breaking changes or migration steps: none. - Real Hopper/Ghidra, browser, or OS coverage: none claimed. - Package or release metadata impact: none. - Security, privacy, process, or containment review: documentation only; existing native admission requirements are preserved. ## Before merge - [x] This PR addresses a concrete documentation gap. - [x] Scope is limited to existing documented behavior. - [x] The PR has one focused outcome and a Conventional Commit title. - [x] Related evidence is linked; no issue closure is claimed. - [x] Required executable validation has completed for this documentation-only change. - [x] Owning documentation is updated; no generated metadata needs editing. - [x] CLI/MCP output is not applicable. - [x] The final diff was reviewed for secrets, unrelated changes, and unsupported claims. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
bsakaguchi 2026-10-31 01:04:20 +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#5147
No description provided.