Community & Contribution

GitHub Issues

The primary place to ask questions, report bugs, and request features is GitHub Issues.

Before opening a new issue:

1. Search existing issues — your question may already be answered.

2. Check the FAQ for common problems and workarounds.

When reporting a bug, include:

• Multik version and module (multik-default, multik-kotlin, or multik-openblas).

• Kotlin version and target platform (JVM, JS, Native, WASM, Android).

• A minimal code sample that reproduces the problem.

• The full error message or stack trace.

Kotlin Slack

Join the Kotlin Slack workspace (request an invite) and look for discussions in the #datascience channel.

Stack Overflow

Tag your questions with kotlin and multik for community visibility.

Setting up the development environment

1. Fork the repository on GitHub and clone your fork.

2. To build all modules including native code, you also need gcc, g++, and gfortran 8+ (same version), and the JAVA_HOME environment variable set.

Ways to contribute

Report bugs

Open an issue with a clear description and a minimal reproducer.

Implement a missing API

The Math, LinAlg, and Statistics interfaces define the operations that each engine must implement. You can add a new function by:

1. Adding the signature to the interface in multik-core.

2. Implementing it in multik-kotlin (pure Kotlin) and/or multik-openblas (native).

When adding or modifying public API, follow the Kotlin library authors' guidelines. Key points: always specify explicit visibility and return types (explicit API mode is enabled), avoid data classes in public API, don't add arguments to existing functions (use overloads), avoid boolean parameters, don't expose mutable state, and use @RequiresOptIn for experimental APIs.

Create a custom engine

Subclass Engine and implement the Math, LinAlg, and Statistics interfaces. Register it at runtime with mk.addEngine() or mk.setEngine().

Improve documentation

Documentation lives in docs/topics/ (Writerside format). API doc samples are in multik-core/src/commonTest/kotlin/samples/docs/ and validated by the Korro plugin.

Add tests

Tests are always welcome. Place JVM tests under src/jvmTest/, common tests under src/commonTest/. Run them with ./gradlew :multik-core:jvmTest (or the corresponding target task).

Submitting a pull request

1. Create a branch from develop.

2. Keep commits focused — one logical change per commit.

3. Add or update tests for any new behavior.

4. Make sure ./gradlew :multik-core:jvmTest passes before submitting.

5. Open a pull request against the develop branch with a clear description of the change.