Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

38 lines (27 loc) · 1.46 KB

Contributing to SmartAuth

If you want to fix or improve the current functionality:

Overview

This project uses Pigeon which is a code generator for communication between Flutter and the host platform. If you want to change add new method or change the existing ones, you need to modify the pigeon/smart_auth_api.dart file and run the following command to generate the new code:

dart run pigeon --input pigeon/smart_auth_api.dart

The generated code will be in the lib/src/smart_auth_api.g.dart and android/src/main/kotlin/fman/ge/smart_auth/smart_auth_api.g.kt, but you don't need to touch these files.

If you want to make changes in the Android part, you need to modify the android/src/main/kotlin/fman/ge/smart_auth/SmartAuthPlugin.kt file.

If you want to make changes in the Flutter part, you need to modify the lib/src/smart_auth.dart file.

Preparing the environment

  1. Fork the repository
  2. Clone the forked repository to your local machine
  3. Create a new branch (git checkout -b improve-feature)
  4. If you want to change anything in Kotlin, run Android Studio, click open and select the build.gradle file in example/android/app/build.gradle. This way, Android Studio will recognize the Android project and run the Gradle sync, so you won't see any errors while working in the Kotlin files
  5. If you want to change anything in Dart, just open the project root folder in any IDE of your choice