Thanks for your interest! Ledger is primarily a reference project, but issues and pull requests are welcome.
- For bugs and questions, use the issue templates.
- For security problems, do not open a public issue — follow the security policy.
- For anything beyond a small fix, please open an issue first so the approach can be discussed before you invest time.
JDK 21+ is required. Useful commands:
./gradlew jvmTest # fastest test pass (JVM targets only, no emulator)
./gradlew allTests # all tests across all platforms
./gradlew check # full gate: tests + API check + lint + coverage floors./gradlew :desktopApp:hotRunCode edits are applied to the running window without a restart. The first run downloads a JetBrains Runtime (hot reload needs its enhanced class redefinition) and caches it outside the project; normal builds are unaffected and keep using the daemon JDK.
The same plugin exposes :desktopApp:hotMcpServer, an MCP endpoint that lets a coding
agent reload, screenshot, read the semantic tree and drive the running app. It attaches to
an app that is already running, so start one with :desktopApp:hotRunAsync first.
.mcp.json wires the endpoint up for MCP clients that read that file. It starts the
wrapper the way the gradlew scripts do internally — java -classpath gradle/wrapper/gradle-wrapper.jar org.gradle.wrapper.GradleWrapperMain — rather than
running ./gradlew. MCP clients spawn the command without a shell, and gradlew is an
extensionless POSIX script that Windows cannot execute; the wrapper JAR is identical on
every platform and needs only java on PATH.
- CI must pass — the
CI Successstatus check gates merges. It runscheck, which includes tests, binary-compatibility validation, and Kover coverage floors. - Public API changes require regenerated dumps: run
./gradlew apiDumpand commit the updated<module>/api/files alongside the code change, orapiCheckfails. One exception: if a JVM dump gains a compiler-generatedComposableSingletons$<File>Ktclass, add it toignoredClassesin the rootbuild.gradle.ktsinstead of committing it. - Tests use fakes, not mocks — see
core:test(FakePostingRepository,FakeSettingsRepository) for the pattern. No mocking libraries. - Architecture rules (layering, feature api/impl split, Koin annotations vs DSL
boundaries) are documented in
CLAUDE.mdand the README architecture section — new code should follow them. - Keep commits focused, with plain conventional-style messages
(
fix: …,feat: …,docs: …).
By participating you agree to abide by the Code of Conduct.