docs: correct the contributor setup instructions - #2584
Closed
Avinash Gola (avinashgola) wants to merge 1 commit into
Closed
Avinash Gola (avinashgola) wants to merge 1 commit into
Avinash Gola (avinashgola) wants to merge 1 commit into
Conversation
Every command in the agent setup path was wrong for the current repo, so a new contributor following CONTRIBUTING.md could not reach a working build. CONTRIBUTING.md: - `yarn install` -> `bun install`. The agent workspace pins `bun@1.3.6` and marks npm/yarn/pnpm as `please-use-bun` in `engines`; there is no yarn.lock. - `cp .env.example .env` -> `cp .env.development.example .env.development`. No `.env.example` exists; the per-app env files were merged into root ones. - `yarn build:dev` -> `bun run dev:setup` and `bun run dev:watch`. There is no `build:dev` script at the workspace root. - The unpacked extension is at `apps/app/dist/chrome-mv3-dev`, not `packages/browseros-agent/dist/`. WXT sets `outDir: 'dist'` and suffixes the mode. - Dropped the link to `packages/browseros-agent/CONTRIBUTING.md`, which does not exist, in favour of the package README and the CLAUDE.md ground rules. - Prerequisites now name Bun, Go (required by `tools/dev/run.sh`, so `dev:setup` and `dev:watch` fail without it) and Rust, instead of "Node.js 18+". - Code standards pointed at the per-package CLAUDE.md files rather than restating them, and the test runner is `bun test`, not Vitest. - Project structure redrawn from the tree as it is: apps/, crates/ and packages/ under browseros-agent, and `bos_build/` rather than `build/`. - Browser setup gained the `uv sync` and `cp .env.example .env` steps the build README documents, plus `--show-plan`. docs/contributing.mdx carried the same class of errors: - `apps/controller-ext` does not exist; listed `apps/cli` instead. - Same per-app env copy, same `dist/` load-unpacked path. - Removed `bun run build:ext`, which is not a script. - Vitest -> `bun test`. Verified by running the documented paths: `bun install`, `bun run codegen:agent` and `bun run build:agent:dev` produce `apps/app/dist/chrome-mv3-dev`, and `uv run browseros build --list` works after `uv sync`. Every relative link and path referenced now resolves. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Contributor
|
PR author is not in the allowed authors list. |
Contributor
|
already fixed in #2666 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A new contributor following
CONTRIBUTING.mdcannot reach a working build today — every command in the agent setup path is wrong for the current repo.CONTRIBUTING.md
yarn installpackages/browseros-agent/package.jsonpinsbun@1.3.6and setsenginesto"yarn": "please-use-bun"(same for npm and pnpm). There is noyarn.lock, onlybun.lock.cp .env.example .env.env.exampleexists. The tracked templates are.env.development.exampleand.env.production.example; the old per-app env files were merged into root ones.yarn build:devbuild:devscript at the workspace root. Setup isbun run dev:setupthenbun run dev:watch.packages/browseros-agent/dist/apps/app/wxt.config.tssetsoutDir: 'dist'and WXT suffixes the mode, so a dev build lands inapps/app/dist/chrome-mv3-dev.packages/browseros-agent/CONTRIBUTING.mdREADME.mdandCLAUDE.md.tools/dev/run.shexits with an install prompt when Go is missing, sodev:setupanddev:watchboth fail without it — plus Rust forcrates/.bun test(apps/apptest script shells out toscripts/run-bun-test.ts, and the agentCLAUDE.mdsaysbun test).src/lib,src/sidepanel,src/newtab,src/backgroundapps/,crates/andpackages/. Alsopackages/browseros/build/is reallybos_build/.Two further changes:
CLAUDE.mdfiles instead of restating them. The hand-copied copy had drifted (Vitest, and Zod/alias rules that aren't in the ground rules) while the real rules — extensionless imports, kebab-case,@browseros/sharedconstants — were missing entirely. Restating them here is what let them rot; the highlights that remain are corrected against the source.uv syncandcp .env.example .envsteps thatbos_build/README.mddocuments, plus--show-plan. The existingbrowseros buildinvocations were correct and are unchanged.docs/contributing.mdx
The published page carries the same class of errors:
apps/controller-extdoes not exist —apps/is app, app-onboard, claw-app, claw-onboard, claw-server-rust, cli, server. Listedapps/cliinstead..env.examplecopies, same baredist/load-unpacked path.bun run build:extis not a script; row removed.bun test.Verification
I ran the documented paths rather than only reading them:
bun install→bun run codegen:agent→bun run build:agent:devproducesapps/app/dist/chrome-mv3-dev. Worth noting:build:agent:devalone fails on a fresh clone (Could not load apps/app/generated/graphql/gql), so the doc names the codegen step explicitly.uv syncthenuv run browseros build --listand--helpboth work, confirming the browser commands and the--chromium-src/--provision/--show-planflags.git diff --checkis clean.No code changes; docs only.
🤖 Generated with Claude Code