Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 796 Bytes

CONTRIBUTING.md

File metadata and controls

47 lines (31 loc) · 796 Bytes

Contributing

Requirements

  • mise — manages pnpm, rust, node (see mise.toml)
  • docker or colima (for redis)

Setup

mise install
pnpm install

Development

pnpm run dev

Make sure docker/colima is running. This starts redis, the rust backend, the web client, and the CLI. The app is at localhost:3000.

Tests

End-to-end tests with Playwright.

pnpm run test:prepare
pnpm run test:local

Release

  1. Update version across packages:

    ./version.mjs <semver>
  2. Create and push the tag:

    git tag v<semver>
    git push --tags

The CI workflow publishes the CLI to npm and the Docker image to Docker Hub automatically.