Add contributor onboarding docs: roadmap, CI ladder, no-build path#124
Conversation
Surface minimum build-host specs at the top of BUILD.md and quickstart, document the no-build contribution path, publish ROADMAP.md with the M1-M5 milestone tracks, document the fork-PR CI ladder in CONTRIBUTING.md, and link Discussions and the new pages from the README Community section. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c21815fe8e
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| `check.sh` skips the standalone Java compile check when no Android SDK is | ||
| present (or set `OPENPHONE_SKIP_JAVA_CHECK=1`). Everything else — required |
There was a problem hiding this comment.
In a no-SDK environment, this setup path still fails: scripts/check.sh unconditionally invokes scripts/check-assistant-java.sh, and that script exits with FAIL — no android.jar found unless OPENPHONE_SKIP_JAVA_CHECK=1 is set. As written, laptop-only contributors following the no-build instructions run ./scripts/check.sh and hit the Java gate instead of the promised skip, so the no-build onboarding path is not reproducible without manually discovering the environment variable.
Useful? React with 👍 / 👎.
| the ADB/MCP surface. In progress — capability inference now fails closed and | ||
| the external ADB/MCP transport refuses state-changing tools by default. |
There was a problem hiding this comment.
This line says the safety fixes have already landed, but the current code paths still do not enforce those guarantees: ActionRegistry.load() can return an unloaded registry and FrameworkToolExecutor.execute() only rejects missing tools when isLoaded() is true, while integrations/mcp-server/src/index.mjs forwards tools/call to transport.invoke() and the ADB transport executes state-changing commands like openphone.app.open, openphone.ui.tap, and openphone.clipboard.set unless dry-run is explicitly enabled. In contexts where maintainers use the roadmap to decide whether M1 is safe for wider distribution, this overstates the current safety posture.
Useful? React with 👍 / 👎.
| `./scripts/check.sh` (required files, JSON validity, schema | ||
| cross-consistency, runtime protocol validation, broker smoke test, Node | ||
| contract tests, assistant Java compile check), and `git diff --check`. | ||
| Run `./scripts/check.sh` locally before pushing — it is the same check. |
There was a problem hiding this comment.
For docs changes, this instruction is not equivalent to tier 1: .github/workflows/ci.yml runs ./scripts/build-docs.sh as a separate step before ./scripts/check.sh, and check.sh itself does not build the Fumadocs site. Contributors following this line can push Markdown/nav changes that pass locally but fail the automatic PR job, so the CI ladder should tell them to run the docs build too when relevant.
Useful? React with 👍 / 👎.
1 participant
Summary
docs/BUILD.mdanddocs/quickstart.mdinstead of burying them in the EC2 sectiondocs/contributing/no-build.mddocumenting the surfaces contributable without an Android build host (schemas, broker, integrations, protocol, docs, scripts) with setup steps and example task walkthroughsROADMAP.mdwith the M1–M5 milestone tracks, status, and links to GitHub milestones.github/CONTRIBUTING.md(automatic checks →run-gcp-lablabel → release/nightly-only workflows)CODE_OF_CONDUCT.md (#93) is intentionally excluded from this batch.
Test plan
./scripts/check.shpasses (includes docs link checks and Java compile)./scripts/build-docs.shbuilds the docs site with the newcontributingnav sectiongit diff --checkcleanCloses #90
Closes #91
Closes #95
Closes #96
🤖 Generated with Claude Code