Lumina Monorepo

Monorepo for Lumina, a dex for the Mina Blockchain.

Contributing Guide

Prerequisites

• Node.js
• Bun
• pnpm

Install the dependencies

pnpm i

Git Hooks

We use lefthook to manage githooks. It should work out of the box, but after running pnpm i, you should run pnpm lefthook install to ensure it's set up correctly.

Github Workflow

1. Pull the latest changes from main.

git switch main && git pull

2. Do some work on the main branch.

3. Create a new branch for your changes.

git switch -c feature/my-changes

4. Commit your changes.

git add . && git commit -m "feat: my changes"

5. Push your changes and create a PR

#Using the github cli this pushes the branch and creates a PR
gh pr create

#Or you can use git and manually create the PR
git push -u origin feature/my-changes

Creating Releases

We use changesets to manage releases. Follow the GitHub workflow, and add a changeset to your PR to create a new release.

npx changeset

Then merge your PR. Publishing to NPM will be automated with GitHub Actions.

Formatting

You'll need to install dprint to get the vscode extension working.

curl -fsSL https://dprint.dev/install.sh | sh