Thanks for your interest in contributing to hyperellipse!
bun install
bun run dev # docs + package watch
bun run build
bun run test
bun run check
bun run check-types-
Fork the repo and create a branch from
main. -
Make your changes in
packages/hyperellipse. -
Add or update tests when changing parser or geometry logic.
-
Run
bun run checkandbun run testbefore opening a PR. -
Add a changeset when your change should trigger a release:
bun changeset
-
Open a pull request with a clear description and screenshots for visual changes.
Commits must follow Conventional Commits:
feat(hyperellipse): add superellipse parsing for scientific notation
fix: correct radius overlap scaling
chore: update CI workflow
Only hyperellipse is published to npm, via Changesets on a maintainer machine:
bun changeset
bun version-packages
bun releasePlease include:
- Browser and version
- Minimal HTML/CSS reproducer
- Expected vs actual rendering
- Whether native
corner-shapeis supported (compare in Chrome vs Safari/Firefox)