SwissKnife Docs
Developers

Contributing

Prepare your environment and open a focused pull request.

The complete rules are in the product repository's CONTRIBUTING.md.

Environment

  1. Fork and clone the repository.
  2. Use Node.js 22 (package.json engines).
  3. Install from the lockfile and start the application:
npm ci
npm run dev

Interface: http://127.0.0.1:2499.

The server remains local by default. Use npm run dev:lan only to test from another device on a trusted local network.

Docker build from source: docker compose -f docker-compose.yml -f docker-compose.build.yml up -d --build → http://127.0.0.1:2501.

Before opening a pull request

npm run lint
npm test
npm run build
  • keep each pull request focused on one coherent topic;
  • use Conventional Commits (feat:, fix:, docs:, chore:);
  • open the pull request against main;
  • never commit .env, dist/, or node_modules/.

Vulnerabilities follow the Security policy. Conduct is governed by CODE_OF_CONDUCT.md.

On this page