Skip to content

Contributing ​

Pull requests are welcome!

Conventional Commits ​

This project uses Conventional Commits to automate versioning and changelog generation. Use the following prefixes in your commit messages:

PrefixVersion bumpExample
fix: …patch (1.0.x)fix: correct cell resolution output
feat: …minor (1.x.0)feat: add ISEA4T grid support
feat!: … / fix!: …major (x.0.0)feat!: rename cellToChildren

A release PR is opened automatically by the bot after commits land on main. Merging it creates the GitHub release and publishes to npm.

Development Setup ​

Prerequisites ​

Project Structure ​

FolderDescription
src-cppDGGRID C++ source (inspired by DGGRIDR)
src-tsTypeScript wrapper around the Emscripten output
lib-wasmJS/WASM output from Emscripten
lib-wasm-pyExperimental Python wrapper build
testsJS unit tests

Build ​

bash
yarn install
yarn build

This compiles the WASM via Emscripten and builds the TypeScript wrapper and bundles.

Test ​

bash
yarn test