Contributing

How to contribute

Glacier is open source and contributions are welcome — from typo fixes to new framework adapters. This page gets you from clone to pull request.


Local setup

git clone https://github.com/glacier/glacier
cd glacier
npm install
npm run build
npm test

The repo is a monorepo. The most-touched packages are:

  • packages/core — the predictor, store, and public API
  • packages/react — the React provider and hooks
  • packages/* — framework adapters (next, remix, …)

Making a change

  1. Branch from main: git checkout -b fix/your-thing.
  2. Add or update tests — every change ships with coverage.
  3. Run npm test and npm run lint until both are green.
  4. Add a changeset: npx changeset (this drives the release notes).

Opening the pull request

Keep PRs focused and describe the why, not just the what. Link the issue it closes. A maintainer will review within a few days.

Not sure where to start?

Issues tagged good first issue are scoped to be approachable without deep knowledge of the predictor. Adapters for new frameworks are also a great first contribution — they're mostly wiring.

See the Architecture guide before diving into core, and the Design principles for the rules that keep changes consistent.

Previous
Glacier.sync()