Dev Environment & Conventions

Home / Guides & Runbooks / Dev Environment & Conventions

How to set up a local development environment and the conventions we follow once you're in the code. New engineers should pair this with Accounts & Access and the Developer Workstations spec.

Scaffold — fill in per-repo specifics

This page captures the cross-cutting conventions. Repo-specific build steps belong in each repo's README; link the canonical ones from Key Repositories.

---

Local Setup

1. Get provisioned — see Accounts & Access.
2. Clone from the anvil-co GitHub organization.
3. Follow the repo README for language toolchain and build steps.
4. For ModuleWorks / Windows-only builds, use the Shared Windows Debug Machine.

Branching & Pull Requests

• TBD: branch naming, base branch, who reviews, merge strategy.
• Keep PRs scoped and reviewable; write a description that says what changed and why.

Coding Standards

• TBD: formatters, linters, language-specific style per repo.

CI / CD

• CI runs in GitHub Actions. The AutoCAM testing suite describes the benchmark harness pattern.
• This docs site deploys automatically to Cloudflare Pages on push to main.
• TBD: required checks, how to read a failed build, how to re-run.

Release Flow

• TBD: versioning, tagging, and release cadence per artifact.