Skip to content

docs(README): add Ninja + ripgrep to the Contributing-from-source prereqs list#1869

Merged
senamakel merged 1 commit into
tinyhumansai:mainfrom
aregmii:docs/readme-prereqs-sync
May 16, 2026
Merged

docs(README): add Ninja + ripgrep to the Contributing-from-source prereqs list#1869
senamakel merged 1 commit into
tinyhumansai:mainfrom
aregmii:docs/readme-prereqs-sync

Conversation

@aregmii
Copy link
Copy Markdown
Contributor

@aregmii aregmii commented May 15, 2026

Summary

  • Adds Ninja and ripgrep to bullet 1 of the README's "Contributing from source" section so the short-path tool list matches CONTRIBUTING.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.md already requires Ninja (added in #1783), and ripgrep is 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. Inserts Ninja, ripgrep between CMake and and the platform desktop build prerequisites. No changes to structure, headings, or the deeper-link block beneath bullet 3 — those continue to point at CONTRIBUTING.md for the full table.

Submission Checklist

  • N/A — pure prose change to a markdown file; no behavior to test.
  • N/A — markdown line not covered by Vitest or cargo-llvm-cov.
  • N/A — no feature rows affected.
  • N/A — no feature IDs touched.
  • N/A — no external dependencies introduced; documents existing prereqs.
  • N/A — no release-cut surfaces touched.
  • Linked issue closed via Closes #1868 in the ## Related section.

Impact

Fresh contributors who read only the README still install Ninja and ripgrep, and don't hit the two git push failures (cef-dll-sys CMake abort / rg: command not found) that motivated #1783 and #1867.

Related


AI Authored PR Metadata (required for Codex/Linear PRs)

N/A — Human-authored fix. AI-assisted drafting; not a Codex/Linear autonomous PR.

Linear Issue

  • Key: N/A
  • URL: N/A

Commit & Branch

  • Branch: docs/readme-prereqs-sync
  • Commit SHA: 3b629745

Validation Run

  • N/A — no JS/TS changed.
  • N/A — no TS types changed.
  • N/A — no TS to compile.
  • N/A — no Rust changed.
  • N/A — no Tauri code changed.

Validation Blocked

  • command: pre-push hook pnpm rust:check (cargo check --manifest-path src-tauri/Cargo.toml) may still exit 101 on upstream main (inherited failure documented in fix(scripts): codesign setup pops keychain dialog on every build + dr… #1786). This branch only edits README.md so the failure cannot be caused by this change.
  • error: (as above)
  • impact: Pushed with --no-verify per CLAUDE.md guidance for hook failures unrelated to the change.

Behavior Changes

  • Intended behavior change: None — documentation only.
  • User-visible effect: Fresh contributors reading only the README see the correct tool list.

Parity Contract

  • Legacy behavior preserved: Yes — no runtime code touched.
  • Guard/fallback/dispatch parity checks: N/A — no dispatch path touched.

Duplicate / Superseded PR Handling

  • Duplicate PR(s): None. Verified no open PR touches README.md (28 open PRs scanned via GitHub API at commit time).
  • Canonical PR: This one.
  • Resolution: N/A.

Summary by CodeRabbit

  • Documentation
    • Updated contributing setup prerequisites to include additional tooling (Ninja and ripgrep) required for building from source.

Review Change Stack

…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.
@aregmii aregmii requested a review from a team May 15, 2026 22:40
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 15, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2e5d009c-5f26-475f-b63d-03ce46b54958

📥 Commits

Reviewing files that changed from the base of the PR and between 3e148f6 and 3b62974.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

The README's "Contributing from source" prerequisites list is updated to explicitly include Ninja and ripgrep alongside existing tool requirements (Git, Node.js, pnpm, Rust, CMake) to reflect tools contributors encounter during first build and pre-push lint workflows.

Contributing prerequisites documentation

Layer / File(s) Summary
README prerequisites list update
README.md
Line 71 adds Ninja and ripgrep to the short prerequisites list in the "Contributing from source" section, aligning with CONTRIBUTING.md and reflecting build and lint workflow dependencies.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related issues

  • #1868: Directly addresses the issue requesting explicit Ninja and ripgrep in the README prerequisites list.
  • #1866: Related documentation update for ripgrep contributor setup.

Possibly related PRs

  • tinyhumansai/openhuman#1783: Adds Ninja as a documented macOS build prerequisite in CONTRIBUTING.md; this PR brings that requirement into the README summary.

Poem

A rabbit hopped through the build,
And bumped on two tools unfulfilled,
Ninja and grep, now listed clear,
So all contributors can build here! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding Ninja and ripgrep to the README's Contributing-from-source prerequisites list.
Linked Issues check ✅ Passed The PR directly fulfills issue #1868's acceptance criterion by adding Ninja and ripgrep to the README's prerequisites list alongside existing tools.
Out of Scope Changes check ✅ Passed The PR changes only the README prerequisites list as scoped in #1868, with no structural reorganization or macOS-specific notes added.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@senamakel senamakel merged commit 26cdbdd into tinyhumansai:main May 16, 2026
23 checks passed
@aregmii aregmii deleted the docs/readme-prereqs-sync branch May 16, 2026 03:46
AusAgentSmith pushed a commit to AusAgentSmith/openhuman that referenced this pull request May 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(README): Contributing-from-source prereqs list missing Ninja + ripgrep

2 participants