Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 873 Bytes

CONTRIBUTING.md

File metadata and controls

24 lines (17 loc) · 873 Bytes

Contributing

Prerequisites

  • Node.js 20+
  • Bun 1.3+

Install the workspace dependencies with bun install. Run bun run check before opening a pull request; it type-checks and tests every publishable package. Run bun run build to verify release artifacts and demos.

Design guidelines

  • Keep @three-roads/core free of renderer dependencies.
  • Keep meshes in typed arrays and renderer adapters outside the mesher.
  • Add a scenario and a focused test for a changed geometry or topology rule.
  • Prefer small modules with explicit types and deterministic output.

Releases

Every package is versioned independently. Update a package version and its internal dependency ranges together, run bun run check, then use npm pack --dry-run --workspace <package> to inspect the publish payload. Publish with npm publish --workspace <package> --access public.