Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (32 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

46 lines (32 loc) · 1.22 KB
Raw

Contributing

Local setup

Use JDK 25. The Gradle wrapper and Foojay resolver can provision the configured toolchain.

./gradlew build

Required verification

Run the same gate as CI before committing:

./gradlew clean build spotlessCheck

Apply formatting with:

./gradlew spotlessApply

Tests live with their owning module. lumentika-core contains runtime and integration tests; lumentika-ksp compiles generated DSL fixtures. CI uploads HTML test reports when the gate fails.

Repository modules

Module Role
lumentika-core Runtime and public UI APIs
lumentika-ksp @UIComponent DSL generator
app Executable integration example
utils Local sample support
buildSrc Shared Gradle conventions

Change guidelines

  • Keep rendering-environment types out of reusable core APIs.
  • Preserve retained element identity and owner-scoped cleanup.
  • Add tests for public behavior, invalidation, lifecycle, and failure cases.
  • Update user documentation when public APIs or adapter contracts change.
  • Treat API changes as potentially breaking while releases remain 0.x.

The project uses conventional commit messages and the Apache-2.0 license.