Skip to content
This repository was archived by the owner on Mar 30, 2026. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (35 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

52 lines (35 loc) · 1.59 KB

Contributing

Thanks for your interest in contributing to this project.

Development setup

# Install Rust (rustup will use rust-toolchain.toml)
rustup show

# Install JS tooling and hooks
bun install

Commands

Command Description
bun run format Format Rust code (cargo fmt)
bun run lint Lint with Clippy (cargo clippy)
bun run test Run tests (cargo test)
bun run test:coverage Coverage with cargo-tarpaulin (optional; run cargo install cargo-tarpaulin first)
bun run check Lint/format JS/TS (Biome)
bun run commit Commit with Commitizen (conventional commits)

Commit messages

We use Conventional Commits and commitlint. Use:

bun run commit

Examples: feat: add foo, fix: bar, chore(deps): bump x.

Pull requests

  1. Branch from main, make changes, run bun run format, bun run lint, bun run test.
  2. Push and open a PR. CI will run format check, Clippy, and tests on Ubuntu, Windows, and macOS.
  3. Keep the scope small and the title/commits clear.

Releasing

Maintainers use:

  • bun run bump:patch / bump:minor / bump:major to bump version in Cargo.toml, commit, tag, and push.
  • bun run release to generate changelog and sync a GitHub release.

Publishing to crates.io is done manually when ready.