Contributing

Development workflow

docker compose up -d postgres redis
pnpm install
pnpm db:migrate
pnpm api:dev
pnpm web:dev
pnpm worker:dev

Contribution standards

• Keep changes focused and easy to review.
• Follow existing module, component, naming, and permission patterns before adding abstractions.
• Include verification notes for builds, type checks, tests, migrations, and Docker changes that apply.
• Avoid committing local environment files, generated build output, dependency folders, uploaded files, or temporary artifacts.
• Update EN and FR documentation when behavior, configuration, security boundaries, or operator steps change.
• Keep maintainer implementation records separate from audience-focused documentation.
• Review authentication, authorization, encrypted chat, storage deletion, and automation changes as security-sensitive.

Prisma migration discipline

Generate migrations from the current schema, inspect SQL before applying it, and use Prisma status and resolve workflows for failures. Never edit or delete an applied migration to repair an active database. Prefer an additive corrective migration and roll-forward recovery.

Checks before PR

pnpm --filter @pe/api build
pnpm --filter @pe/web build
pnpm --filter @pe/worker build
git diff --check