docs(README): add Ninja + ripgrep to the Contributing-from-source prereqs list#1869
Conversation
…rereqs The short prereqs list in README.md hasn't been kept in sync with CONTRIBUTING.md's expanded prerequisites table: - Ninja was added to CONTRIBUTING.md in tinyhumansai#1783 (required on macOS for the CEF helper compile). - ripgrep is being added to CONTRIBUTING.md in tinyhumansai#1867 (required by the `lint:commands-tokens` pre-push step). Add both to README.md's bullet 1 so contributors who read only the README still get the full tool list. "Platform desktop build prerequisites" continues to cover the macOS-specific x86_64 target and codesign script — those are spelled out in the deeper CONTRIBUTING.md doc that this README section already points at.
|
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)
📝 WalkthroughWalkthroughThe README's "Contributing from source" prerequisites list is updated to explicitly include Contributing prerequisites documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related issues
Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
Summary
Ninjaandripgrepto bullet 1 of the README's "Contributing from source" section so the short-path tool list matchesCONTRIBUTING.md's prerequisites table.Problem
The README's "Contributing from source" summary lists
Git, Node.js 24+, pnpm 10.10.0, Rust 1.93.0 (rustfmt + clippy), CMake, and the platform desktop build prerequisites. That list is stale:CONTRIBUTING.mdalready requiresNinja(added in #1783), andripgrepis being added in #1867. Contributors who read only the README's short path install the wrong set of tools and hit the same fresh-contributor failures we filed those PRs to document.Solution
One-line edit to
README.md. InsertsNinja, ripgrepbetweenCMakeandand the platform desktop build prerequisites. No changes to structure, headings, or the deeper-link block beneath bullet 3 — those continue to point atCONTRIBUTING.mdfor the full table.Submission Checklist
Closes #1868in the## Relatedsection.Impact
Fresh contributors who read only the README still install Ninja and ripgrep, and don't hit the two
git pushfailures (cef-dll-sysCMake abort /rg: command not found) that motivated #1783 and #1867.Related
ripgreptoCONTRIBUTING.md's full prerequisites table. This PR's README mention ofripgrepstands on its own (the actual requirement is thelint:commands-tokensscript inapp/package.json, which exists onmaintoday), but reviewers may prefer to merge fix(lint): make commands-tokens script fail with a clear error when ripgrep is missing + add to CONTRIBUTING prereqs #1867 first so both docs land in sync. Happy to rebase / split if preferred.AI Authored PR Metadata (required for Codex/Linear PRs)
Linear Issue
Commit & Branch
docs/readme-prereqs-sync3b629745Validation Run
Validation Blocked
command:pre-push hookpnpm rust:check(cargo check --manifest-path src-tauri/Cargo.toml) may still exit 101 on upstreammain(inherited failure documented in fix(scripts): codesign setup pops keychain dialog on every build + dr… #1786). This branch only editsREADME.mdso the failure cannot be caused by this change.error:(as above)impact:Pushed with--no-verifyperCLAUDE.mdguidance for hook failures unrelated to the change.Behavior Changes
Parity Contract
Duplicate / Superseded PR Handling
README.md(28 open PRs scanned via GitHub API at commit time).Summary by CodeRabbit