Developers

Contributing

Prepare the environment and open a focused pull request.

Full rules are in the product repository's CONTRIBUTING.md.

Environment

  1. Fork and clone the repository.
  2. Use Node.js 22.x.
  3. Install from the lockfile:
npm ci --include=optional
npm run dev

The server remains local by default. npm run dev:lan exposes it explicitly on the local network when required for testing.

Before a pull request

npm run check
  • keep each pull request focused on one coherent topic;
  • use conventional commits (feat:, fix:, docs:, test:);
  • state which validations were actually run;
  • add before-and-after screenshots for visual changes;
  • update English, French, Spanish and German together when user-facing copy changes;
  • never commit .env, API keys, dist/ or node_modules/.

Discussions follow the code of conduct. Vulnerabilities follow the Security policy.

Tests and validation

Run lint, TypeScript, Vitest and both builds before delivery.

Security policy

Supported versions and the private channel for reporting a vulnerability.