Thanks for contributing to bun-scikit.
- Install Bun
>=1.3.9. - Install project dependencies:
bun install
- (For Python comparison benchmarks) install Python deps:
python -m pip install -r bench/python/requirements.txt
- Run tests:
bun run test - Typecheck:
bun run typecheck - Generate API docs:
bun run docs:api:generate - Check API docs coverage:
bun run docs:coverage:check - Heart benchmark (human-readable):
bun run bench - Heart classification benchmark (human-readable):
bun run bench:heart:classification - Heart tree benchmark (human-readable):
bun run bench:heart:tree - Generate CI benchmark snapshot locally:
bun run bench:snapshot
- Keep changes scoped to one objective.
- Include tests for behavioral changes.
- Run locally before opening PR:
bun run testbun run typecheckbun run docs:coverage:checkbun run bench:readme:check(if benchmark files were changed)
- Update docs when public APIs or workflows change.
- Add changelog entries under
## [Unreleased]inCHANGELOG.md.
- Use clear, imperative commit messages.
- Prefer conventional prefixes (
feat:,fix:,docs:,test:,ci:,chore:).
- Benchmark table content in
README.mdis generated frombench/results/heart-ci-latest.json. - Do not hand-edit the benchmark section in
README.md. - Use
bun run bench:sync-readmeto regenerate from the snapshot file.