Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

34 lines (26 loc) · 1.34 KB
Raw

Contributing

Development

Create a local.properties in the root of the project with paths to inform Gradle where to find the Android SDK and CocoaPods:

# Replace the paths with the actual paths on your machine
sdk.dir=/Users/sargunv/Library/Android/sdk
kotlin.apple.cocoapods.bin=/opt/homebrew/bin/pod

Follow Jetbrains's instructions for setting up an environment for KMP development.

Once set up, if you're using Fleet, you can use the preconfigured run configurations in this repo to launch the demo app or run tests.

If you're not using Fleet, use Android Studio to launch the demo app on Android, XCode to launch on iOS, and Gradle to run the tests:

  • Android emulator tests: ./gradlew connectedDebugAndroidTest
  • iOS simulator tests: ./gradlew iosSimulatorArm64Test

A Git pre-commit hook is available to ensure that the code is formatted before every commit. Run ./gradlew installGitHooks to install it. It will run ./gradlew spotlessApply before every commit. To run the formatter, you'll need to have swift installed (for swift format) and npm installed (for prettier). Or run just ./gradlew spotlessKotlinApply spotlessKotlinGradleApply to skip those dependencies.