Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (33 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

48 lines (33 loc) · 1.14 KB
Raw

Contributing

Local Setup

cp .env.example .env
yarn install
yarn dev:up
yarn start:dev

The backend expects PostgreSQL on the connection strings defined in .env.

Before Opening A Pull Request

Run:

yarn verify

That command is the expected contributor gate for this repository.

Test Buckets

  • yarn test:unit covers repository logic and local helpers
  • yarn test:integration covers PostgreSQL-backed query code
  • yarn test:smoke covers the HTTP server health path
  • yarn test:external is opt-in and intended for live dependency checks only

Change Expectations

  • keep changes scoped to the behavior you are modifying
  • add or update tests when controllers, repositories, jobs, or config behavior change
  • update docs when environment variables, scripts, or local setup changes

Environment And Secrets

  • never commit .env files
  • keep credentials and provider keys out of source control
  • prefer env-driven configuration over hardcoded endpoints for anything deployment-specific

Local Dependencies

Use yarn dev:up and yarn dev:down to manage the disposable PostgreSQL container during development.