Contributor guide¶
Repository layout¶
The :kffi module contains the public multiplatform runtime:
commonMaindefines theexpectAPI and shared callback/memory contracts;jvmMain,androidMain, andnativeMainprovide backend implementations;- the
kffi-benchmark-*modules contain platform-specific benchmark harnesses.
Before opening a pull request¶
- Run the JVM suite:
./gradlew :kffi:jvmTest
- Run the platform-specific checks relevant to the change. The commands used by CI are documented in the README.
- Follow CONTRIBUTING.md for the pull-request contract and commit conventions.
- Regenerate and inspect the documentation when public APIs or examples change:
./gradlew :docs:embedDokkaIntoMkDocs
mkdocs build -f docs/mkdocs.yml