docs(CONTRIBUTING): add missing macOS prereqs (Ninja, x86_64 target, …#1783
Conversation
…codesign) Following the current CONTRIBUTING.md on a clean macOS produces three sequential `pnpm --filter openhuman-app dev:app` failures before reaching a working app: 1. Ninja is required by CMake when building the bundled CEF helper, but is not listed as a prerequisite. 2. The CEF helper builds a universal binary so the x86_64 target is required even on Apple Silicon, but rustup only installs the native target by default. 3. `scripts/setup-dev-codesign.sh` exists to create the local "OpenHuman Dev Signer" certificate, but is not referenced anywhere a contributor would look. Adds: - Ninja row to the prerequisites table. - `rustup target add x86_64-apple-darwin` to the macOS bootstrap snippet. - A macOS platform-notes bullet pointing at the codesign setup script. No code or scripts changed.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughCONTRIBUTING.md is updated to document three previously undocumented macOS setup requirements: Ninja as a build tool prerequisite, the x86_64-apple-darwin Rust target for CEF universal binary compilation, and a one-time dev codesigning certificate setup using the existing setup script. ChangesmacOS Build Prerequisites and Setup
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
thanks for the contribution |
Summary
ninjato the prerequisites table — required by CMake when building the CEF helper on macOS.rustup target add x86_64-apple-darwinto the macOS bootstrap snippet — the CEF helper builds a universal binary, so the x86_64 target is needed even on Apple Silicon.scripts/setup-dev-codesign.shfirst-run helper.Problem
Following CONTRIBUTING.md exactly on a clean macOS install fails three times in sequence on
pnpm --filter openhuman-app dev:app(Ninja missing, x86_64 target missing, signing identity missing) before reaching a working app. None of these prerequisites are mentioned today.Solution
Doc-only change to CONTRIBUTING.md. No code, scripts, or behavior changed. The
scripts/setup-dev-codesign.shalready exists in the repo — we just reference it from the place a fresh contributor would actually look.Submission Checklist
Closes #1781in the## RelatedsectionImpact
Reduces fresh-contributor friction on macOS from "three failed builds, internet-search the errors" to "follow the doc, app boots." No runtime, performance, security, migration, or compatibility implications.
Related
scripts/setup-dev-codesign.sh(the freshly-imported cert needssecurity set-key-partition-listto grant codesign access without a Keychain dialog every build).ripgrepto the prerequisites table — thelint:commands-tokenspre-push step shells out torgwithout a presence check.AI Authored PR Metadata (required for Codex/Linear PRs)
Linear Issue
Commit & Branch
docs/contributing-setup-macos70df9119Validation Run
Validation Blocked
command:pre-push hookpnpm rust:check(cargo check --manifest-path src-tauri/Cargo.toml)error:exits 101 on the unmodifiedupstream/mainHEAD (commitf583829d); this branch only editsCONTRIBUTING.md, so the failure is inherited from upstream and unrelated to this PR.impact:Pushed with--no-verifyperCLAUDE.mdguidance for hook failures unrelated to the change.Behavior Changes
Parity Contract
Duplicate / Superseded PR Handling
Summary by CodeRabbit