Contributing to Slonik

Setup Instructions

pnpm install

pnpm run -r build
pnpm run -r lint
pnpm run -r test

Running Slonik tests requires having a local PostgreSQL instance.

The easiest way to setup a temporary instance for testing is using Docker, e.g.

docker run --name slonik-test --rm -it -e POSTGRES_PASSWORD=postgres -p 5432:5432 postgres -N 1000

We use Changesets to manage releases.

When done with your changes, run pnpm changeset to create a new changeset.

Then commit the changes and push to your branch.