docs: clarify local development setup#2828
Open
gbsierra wants to merge 2 commits into
Open
Conversation
|
✅ No security or compliance issues detected. Reviewed everything up to 3e779a0. Security Overview
Detected Code Changes
|
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
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.
Checklist
uv run pytest tests)?pre-commit run --all-files)?Description
This PR improves local development onboarding.
It updates
CONTRIBUTING.mdwith supported development environments, requiredtools, and the
just doctorsetup check.It also adds
just doctor, which checks common local requirements beforecontributors start the full development stack.
Related Issues
Fixes #2827
Screenshots / Recordings
Git Bash:

WSL:

Steps to QA
Confirm it reports available and missing tools.
After all checks pass, run:
http://localhost:80.Summary by cubic
Clarifies local development setup and adds a
just doctorcheck to catch missing tools early. This reduces setup issues across macOS, Linux, and WSL2.just doctor(viascripts/dev-doctor) to validate local prerequisites: OS support,bash,docker+docker compose,curl,git,jq,node,openssl,pnpm,uv,just, and Docker daemon availability. Prints clear next steps and exits non-zero on failures.CONTRIBUTING.mdwith supported environments, required tools, WSL2/Docker guidance, quick start usingjust doctorandjust cluster up -d --seed, seeded users, and helpfuljust clustercommands.doctortarget tojustfile.Written for commit 3e779a0. Summary will update on new commits.