Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
91 lines (63 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

91 lines (63 loc) · 1.72 KB

Contributing to Digarr

Dev setup

git clone https://github.com/iuliandita/digarr.git
cd digarr
bun install

The fastest way to get a dev environment running:

./scripts/dev-setup.sh

This starts PostgreSQL in Docker, installs deps, runs migrations, and copies .env.example.

Or set it up manually:

docker run -d \
  --name digarr-pg \
  -e POSTGRES_USER=digarr \
  -e POSTGRES_PASSWORD=digarr \
  -e POSTGRES_DB=digarr \
  -p 5432:5432 \
  postgres:17-alpine

Copy the env file and set your API keys:

cp .env.example .env
# edit .env with your Lidarr URL/key, Last.fm key, etc.

Run migrations and start the dev servers:

bun run db:migrate
bun run dev          # backend on :3000
bun run dev:web      # frontend on :5173 (proxies /api to :3000)

Code style

Digarr uses Biome for linting and formatting.

bun run lint        # check
bun run lint:fix    # auto-fix

TypeScript strict mode is enforced. No any -- use unknown, generics, or proper types.

Testing

bun run test         # run once
bun run test:watch   # watch mode

Tests live in tests/. Keep them close to the code they cover.

Submitting a PR

  1. Fork and create a branch: git checkout -b feat/my-thing
  2. Make your changes, keeping commits focused
  3. Confirm lint, typecheck, and test all pass
  4. Open a PR against main -- fill in the template
  5. A maintainer will review; be ready to iterate

Commit style

Conventional commits: type(scope): description

Types: feat, fix, docs, refactor, chore, ci

Examples:

  • feat(pipeline): add spotify source
  • fix(lidarr): handle 404 on artist lookup
  • docs: update contributing guide