Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
24 lines (17 loc) · 1.04 KB

CONTRIBUTING.md

File metadata and controls

24 lines (17 loc) · 1.04 KB
Raw

Contributing

Issues and pull requests are welcome. For security vulnerabilities, follow SECURITY.md instead of opening a public issue.

Development

  1. Install Node.js 22.13 or newer, pnpm 11.10.0, and Docker.
  2. Run pnpm install --frozen-lockfile.
  3. Copy .env.example to .env and generate every required credential.
  4. Start PostgreSQL with docker compose up -d postgres.
  5. Export DATABASE_URL and the required application secrets, then run pnpm run build:packages followed by pnpm run dev.

Before opening a pull request, run:

pnpm run check
PYTHONPATH=sdks/python/src python3 -m unittest discover -s sdks/python/tests -v
cargo test --manifest-path sdks/rust/Cargo.toml
docker compose config --quiet

Keep changes focused, include tests for behavior changes, and avoid committing .env, database exports, credentials, or captured user inputs.

Set TEST_DATABASE_URL to a disposable PostgreSQL database to exercise real event/outbox transactions and multi-worker delivery leases. The storage tests write test data.