71 lines (49 loc) · 1.26 KB

Contributing

Contributions are always welcome!

Development workflow

This project uses a monorepo structure with Bun workspaces.

To get started with the project, run bun install in the root directory:

bun install

Building the library

bun run build

Linting

bun run lint

Type checking

bun run typecheck

Running the example app

Navigate to the example folder and run:

cd example
bun install
bun start

Commit message convention

We follow the conventional commits specification:

fix: Bug fixes (correlates with PATCH in semver)
feat: New features (correlates with MINOR in semver)
docs: Documentation only changes
style: Code style changes (formatting, etc)
refactor: Code refactoring
perf: Performance improvements
test: Adding or updating tests
chore: Maintenance tasks

Releasing

Releases are handled automatically via release-it.

To create a new release:

bun run release

This will:

Bump the version based on conventional commits
Generate/update the changelog
Create a git tag
Publish to npm
Create a GitHub release