Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (42 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

60 lines (42 loc) · 1.88 KB
Raw

Contributing

Thanks for your interest in SignKit. This is a small, early-stage project — please keep changes focused.

Setup

pnpm is required (not npm or yarn); the version is pinned via packageManager in package.json and engine-strict=true in .npmrc. corepack enable is enough to get the right pnpm.

pnpm install
pnpm exec playwright install chromium
cp .env.example .env
pnpm run dev

See docs/development.md for the full local setup, migrations, and repository layout.

Tests

pnpm run test          # full suite: server + browser + create-signkit
pnpm run test:unit     # vitest --project server --project postgres
pnpm run test:browser  # vitest --project browser (Chromium)

PostgreSQL integration suites are skipped unless POSTGRES_TEST_URL points at a disposable database:

POSTGRES_TEST_URL=postgres://signkit_test:signkit_test@127.0.0.1:5432/signkit_test pnpm run test:unit -- --run

Never point POSTGRES_TEST_URL at a database you care about — these suites apply migrations and write data.

Lint and typecheck

pnpm run lint    # prettier --check . && eslint .
pnpm run check   # Paraglide compile + svelte-kit sync + svelte-check
pnpm run format  # prettier --write .

Rust CLI (cli/)

cd cli
cargo fmt --check
cargo clippy --all-targets -- -D warnings
cargo test

Pull requests

  • Keep PRs focused on one change.
  • Add or update tests for any behavior change.
  • Update docs (docs/) when behavior changes — the docs are treated as normative, not incidental.
  • CI (.github/workflows/ci.yml) runs lint, typecheck, the full test suite against PostgreSQL, all three build targets, and the Rust CLI checks; a PR should pass all of it.

License

SignKit is licensed under AGPL-3.0-only (see LICENSE). By contributing, you agree that your contributions are licensed under the same terms.