Developer Guide

This guide walks a new contributor through setting up a local development environment for the example service and making a first change.

Start by cloning the application repository and installing its dependencies with the project's package manager. Once dependencies are installed, copy the sample environment file and fill in the placeholder values described in its comments.

New contributors sometimes assume the local environment needs to match production exactly. It does not — the local setup uses lightweight stand-ins for the database and object storage so that the whole stack can start in seconds.

After the local environment is running, make a small change, run the test suite, and open a pull request following the project's conventional-commit message format. A reviewer from the platform team will pick up the review within one business day.