sandbox-agent/foundry/CONTRIBUTING.md
2026-03-10 22:01:39 -07:00

933 B

Contributing

Development Setup

  1. Clone:
git clone https://github.com/rivet-dev/sandbox-agent-foundry.git
cd sandbox-agent-foundry
  1. Install dependencies:
pnpm install
  1. Build all packages:
pnpm -w build

Package Layout

  • packages/shared: contracts/schemas
  • packages/backend: RivetKit actors + DB + providers + integrations
  • packages/frontend: primary UI surface

Local RivetKit Dependency

Build local RivetKit before backend changes that depend on Rivet internals:

cd ../rivet
pnpm build -F rivetkit

cd /path/to/sandbox-agent-foundry
just sync-rivetkit

Validation

Run before opening a PR:

pnpm -w typecheck
pnpm -w build
pnpm -w test

Dev Backend (Docker Compose)

Start the dev backend (hot reload via bun --watch) and Vite frontend via Docker Compose:

just foundry-dev

Stop it:

just foundry-dev-down