Skip to content

docs: clarify local development setup#2828

Open
gbsierra wants to merge 2 commits into
TracecatHQ:mainfrom
gbsierra:docs/dev-setup-doctor
Open

docs: clarify local development setup#2828
gbsierra wants to merge 2 commits into
TracecatHQ:mainfrom
gbsierra:docs/dev-setup-doctor

Conversation

@gbsierra

@gbsierra gbsierra commented Jun 6, 2026

Copy link
Copy Markdown

Checklist

  • Read CONTRIBUTING.md.
  • PR title is short and non-generic.
  • PR only implements a single feature or fixes a single bug.
  • Tests passing (uv run pytest tests)?
  • Lint / pre-commits passing (pre-commit run --all-files)?

Description

This PR improves local development onboarding.

It updates CONTRIBUTING.md with supported development environments, required
tools, and the just doctor setup check.

It also adds just doctor, which checks common local requirements before
contributors start the full development stack.

Related Issues

Fixes #2827

Screenshots / Recordings

Git Bash:
image

WSL:
image

Steps to QA

  1. Run:
just doctor
  1. Confirm it reports available and missing tools.

  2. After all checks pass, run:

just cluster up -d --seed
  1. Confirm the app is available at http://localhost:80.

Summary by cubic

Clarifies local development setup and adds a just doctor check to catch missing tools early. This reduces setup issues across macOS, Linux, and WSL2.

  • New Features
    • Added just doctor (via scripts/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.
    • Detects native Windows shells and recommends WSL2; supports macOS, Linux, and WSL2.
    • Updated CONTRIBUTING.md with supported environments, required tools, WSL2/Docker guidance, quick start using just doctor and just cluster up -d --seed, seeded users, and helpful just cluster commands.
    • Added doctor target to justfile.

Written for commit 3e779a0. Summary will update on new commits.

Review in cubic

@zeropath-ai

zeropath-ai Bot commented Jun 6, 2026

Copy link
Copy Markdown

No security or compliance issues detected. Reviewed everything up to 3e779a0.

Security Overview
Detected Code Changes
Change Type Relevant files
Configuration changes ► CONTRIBUTING.md
    Update local development setup instructions
    Add prerequisites for development
    Update seeded user information
    Add useful commands for development
► justfile
    Add doctor command
Enhancement ► scripts/dev-doctor
    Implement script to check development environment prerequisites

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 3 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Re-trigger cubic

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.

Stale local development setup docs

1 participant