Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

45 lines (34 loc) · 1.52 KB

Contributing

Thanks for contributing to bun-scikit.

Development Setup

  1. Install Bun >=1.3.9.
  2. Install project dependencies:
    • bun install
  3. (For Python comparison benchmarks) install Python deps:
    • python -m pip install -r bench/python/requirements.txt

Project Commands

  • 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

Pull Request Expectations

  1. Keep changes scoped to one objective.
  2. Include tests for behavioral changes.
  3. Run locally before opening PR:
    • bun run test
    • bun run typecheck
    • bun run docs:coverage:check
    • bun run bench:readme:check (if benchmark files were changed)
  4. Update docs when public APIs or workflows change.
  5. Add changelog entries under ## [Unreleased] in CHANGELOG.md.

Commit Guidelines

  • Use clear, imperative commit messages.
  • Prefer conventional prefixes (feat:, fix:, docs:, test:, ci:, chore:).

Benchmark Policy

  • Benchmark table content in README.md is generated from bench/results/heart-ci-latest.json.
  • Do not hand-edit the benchmark section in README.md.
  • Use bun run bench:sync-readme to regenerate from the snapshot file.