Contributing to Quorum

February 8, 2026 · View on GitHub

Thank you for your interest in contributing! This document provides guidelines for contributing to the project.

Getting Started

Fork the repository on GitHub

Clone your fork locally:

git clone https://github.com/YOUR_USERNAME/quorum-sql.git
cd quorum-sql

Install dependencies:
```
pnpm install
```
Start development server:
```
pnpm dev
```

Development Setup

Docker Setup

# Start database and API server
docker compose up -d db server

# Start frontend
pnpm dev

After services are running, open the setup wizard at:

http://localhost:8080/setup

Database Migrations

When making database changes:

Historical migrations have been squashed into a single baseline: supabase/migrations/00000000000000_squashed_baseline.sql
New migrations must be created after this baseline migration
Never modify the squashed baseline file directly
See supabase/README.md for full database workflow and migration guidance

# Create a new migration
supabase migration new description_of_change

# Apply migrations locally
supabase db reset

# Lint for security issues
supabase db lint

Testing

Run tests and checks before opening a pull request:

# Playwright E2E tests
pnpm test:e2e

# Vitest unit tests
pnpm test:unit

# TypeScript checks
pnpm typecheck
pnpm typecheck:server

# Linting
pnpm lint
pnpm lint:server

Submitting Changes

Pull Request Process

Create a feature branch:

git checkout -b feature/your-feature-name

Make your changes following the coding standards below
Test your changes:
```
pnpm build
pnpm lint
```

Commit with a clear message:

git commit -m "feat: add your change summary"

Push to your fork:

git push origin feature/your-feature-name

Open a Pull Request against main

Commit Message Format

Use Conventional Commits with one of these types:

feat: add user profile editing
fix: correct team invitation email validation
chore: update tooling config
docs: add API documentation
test: add coverage for auth middleware
refactor: split query editor state logic
perf: optimize list query pagination
ci: cache pnpm store in workflow
style: format settings panel component