Contributing

Sqkon is maintained by Mercury and welcomes external contributions — bug reports, documentation fixes, and pull requests.

The canonical contributor guide lives at the repository root: CONTRIBUTING.md. It covers the commit format, branch conventions, CI expectations, and project rules. Please read it before opening your first PR.

Local development

Sqkon uses Gradle and the Just the Docs Jekyll theme. Java 21 and Ruby 3+ are required.

Library

# Run the JVM test suite (primary dev loop)
./gradlew jvmTest

# Run a single test class
./gradlew jvmTest --tests "*.KeyValueStorageTest"

# Verify SQLDelight schema migrations
./gradlew verifySqlDelightMigration

# Publish a snapshot to your local Maven for downstream testing
./gradlew publishToMavenLocal

Documentation site

cd docs
bundle install
bundle exec jekyll serve --livereload
# → http://127.0.0.1:4000/sqkon/

The site rebuilds on save; the API reference is a separate Dokka build and is not regenerated by jekyll serve.

Found a typo or want to suggest an edit? Every page on this site has an “Edit this page on GitHub” link in the footer that takes you straight to the source markdown.