diff --git a/.gitignore b/.gitignore index b1c2003..cf4e433 100644 --- a/.gitignore +++ b/.gitignore @@ -52,7 +52,7 @@ **/.android/gradlew.bat **/.android/local.properties **/.android/**/GeneratedPluginRegistrant.java -/.android/app/google-services.json +**/.android/app/google-services.json # iOS/XCode related **/.ios/**/*.mode1v3 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..29551eb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,65 @@ +# How to Collaborate: + +1. Fork the repository to your own GitHub account. + +2. Open new project in Android Studio using SCM -> git. + +3. Enter URL : +``` +"https://www.github.com/{username}/Open-Mobile" +``` +where username is your GitHub account username. + +4. Create a branch where you can do your work. +Don't work on **master** branch. +``` +$ git branch branchname +$ git checkout branchname +``` + + +### Configure [For Android] +- .android/keystore.properties +- Firebase - google-services.json + +**keystore.properties** + +Setup a keystore.properties at the root folder with following sample detail and your configurations +``` + +# APK sign Keystore details: +key_store_cetificate = yourCertificate.jks +key_store_password = yourStorePassword +key_alias = yourAlias +key_password = yourPassword + +#uncomment release porfile in build.gradle (app-level) + +``` + +**Firebase and google-services.json** + +Setup Firebase for the different environment. +Download the google-services.json and put it in the corresponding folder. + +Production: .android/app/src/google-services.json + + + +5. Stage your work (all files including drawables & don't forget to ignore your keys !) +``` +$ git add . +``` + +6. Commit your changes with a commit message and author details. +``` +$ git commit -m "Name| files| Changes" +``` +OR +``` +CTRL + K from Android Studio +``` + +7. Push changes on forked Repository. + +8. Generate a Pull Request.