Skip to content

Latest commit

 

History

History
43 lines (32 loc) · 959 Bytes

CONTRIBUTING.md

File metadata and controls

43 lines (32 loc) · 959 Bytes

Contributing

Prerequisites

  • Node.js >= 22
  • pnpm
  • Docker + Docker Compose

Setup

pnpm install
docker compose up -d
docker compose exec postgres psql -U postgres -c 'CREATE DATABASE "charlieplan"'
cp mcp-server/.env.example mcp-server/.env
pnpm build

Development

pnpm mcp:dev       # run MCP server in dev mode (stdio transport)
pnpm typecheck     # type check all packages
pnpm lint          # lint with Biome
pnpm lint:fix      # auto-fix lint issues
pnpm test:unit     # unit tests
pnpm test:integration  # integration tests (requires Docker)

Regenerating the Planka API client

The planka-api package is generated from planka-api/planka-swagger.json. After editing the spec:

pnpm planka:generate

Pull requests

  • Keep PRs focused — one concern per PR.
  • Run pnpm typecheck && pnpm lint && pnpm test:unit before submitting.
  • Describe why the change is needed, not just what it does.