kmp-conventions

What problem does it solve?

This reference defines and enforces consistent Kotlin Multiplatform and Compose Multiplatform conventions across the Way of the Goat mobile codebase, reducing ambiguity and onboarding time for developers.

Core Features & Use Cases

• MVVM + Repository pattern with clear layer responsibilities: UI components (Composables) render state, ViewModels manage actions, Repositories abstract DB/network, and DataManagers cache session data.
• Source set discipline and naming: avoid platform leaks by keeping common logic in commonMain and platform-specific code in androidMain/iosMain, with proper expect/actual usage.
• Type-safe identifiers and sealed results: use @JvmInline value classes for IDs and sealed classes for operation results to improve safety and maintainability.
• Guidance for tests and architecture documentation: be explicit about structure, testing approach, and conventions to ease reviews and onboarding.

Quick Start

Read this guide before writing or reviewing any mobile Kotlin code to ensure adherence to the project conventions.