Skip to main content

implement-feature

The end-to-end workflow for adding a feature to Meshtastic-Android, in the order that keeps KMP source sets and the architecture intact. Use this whenever you start implementing a new feature or a sizeable behavior change, before writing any code.

Informations de source

Dépôt
meshtastic/Meshtastic-Android
Dernière activité de la source
21 octobre 2026 à 16:00
Langue détectée de SKILL.md
anglais
Étoiles
1 919
Forks
537

Options d'installation

Le prompt qui vérifie d'abord la source est sélectionné par défaut. Vous pouvez passer à une commande directe ou télécharger une copie locale.

Vérifiez les fichiers source

Lisez SKILL.md et les fichiers associés affichés par SkillsMP avant de décider de l'installer.

Affichage de SKILL.md

SKILL.md
Instructions source · Aperçu en lecture seule
name
implement-feature
description
The end-to-end workflow for adding a feature to Meshtastic-Android, in the order that keeps KMP source sets and the architecture intact. Use this whenever you start implementing a new feature or a sizeable behavior change, before writing any code.
# Skill: Implement a Feature ## Description A step-by-step workflow for implementing a new feature in the Meshtastic-Android codebase, ensuring KMP compatibility and proper architecture. ## Workflow ### 1. Update Dependencies & Aliases - Check `gradle/libs.versions.toml` before adding libraries. - Use `jetbrains-*` aliases for lifecycle/navigation/adaptive dependencies in `commonMain`. - Use `compose-multiplatform-*` aliases for CMP dependencies. ### 2. Define the State & ViewModels - Follow MVI/UDF patterns. - Extend shared ViewModel logic in `feature/<name>/src/commonMain/kotlin/org/meshtastic/feature/<name>/<Name>ViewModel.kt`. - Use `stateInWhileSubscribed` (from `core:ui`) for sharing state flows. - Keep the ViewModel free of Android framework dependencies. ### 3. Build the UI - Use Jetpack Compose Multiplatform (CMP). - Define strings in `core:resources` (see the `compose-ui` skill). - Support adaptive layouts (Large/XL breakpoints). ### 4. Wire Navigation & DI - Define typed route objects in `core:navigation`. - Export the navigation graph as an extension function on `EntryProviderScope<NavKey>` in `commonMain` (e.g., `fun EntryProviderScope<NavKey>.myFeatureGraph()`). - Add the required DI bindings via Koin Annotations (`@Factory`, `@Single`, `@KoinViewModel`) in `commonMain`. - **CRITICAL:** Ensure the module is registered in the app root graphs (`AppKoinModule.kt`, `DesktopKoinModule.kt`) and the navigation is injected into the root entry provider in the host shell. ### 5. Validate Platform Separation - If you need a platform-specific API (like camera or specific mapping SDK), define an interface in `commonMain`, implement it in the host shell, and inject it via `CompositionLocal` or Koin. ### 6. Verify Locally - Run the baseline checks (see `testing-ci` skill): ```bash ./gradlew spotlessApply spotlessCheck detekt detektTypeResolved assembleDebug test allTests ``` - Add `kmpSmokeCompile` to the command when the feature touches a KMP module (most features do) so cross-target compile failures surface before merge. - If the feature adds a new reflection-heavy dependency, add its keep rules to `config/proguard/shared-rules.pro` (both R8 and desktop ProGuard apply it), or to `androidApp/proguard-rules.pro` / `desktopApp/proguard-rules.pro` when only one platform needs them, then verify release builds: ```bash ./gradlew assembleFdroidRelease :desktopApp:runRelease ```
Voir sur GitHub