@algocare/react-native-code-push 12.6.3 → 13.0.0-rc.0

package/CONTRIBUTING.md

@@ -1,134 +0,0 @@
-# Contributing
-
-## Using the plugin
-
-### Environment setup
-
-`node.js` and `npm` are needed for using this project. `npm` comes bundled with the `node.js` installer. You can download the `node.js` installer here: https://nodejs.org/download/.
-
-Once you have installed `node.js` and `npm`, install the dev dependencies for the project.
-
-```
-npm install
-```
-
-### Using the plugin manually
-
-Follow these steps to test your modifications to the plugin manually:
-- clone this repository
-- install the dependencies
-
-	Navigate to the root folder from your command line console and run:
-	```
-	npm install
-	```
-- install the plugin in a React-Native project
-
-	Navigate to the root folder of your React-Native project from your command line console and run:
-	```
-	npm install local_path_to_your_clone_of_this_repo
-	```
-- configure the plugin using the steps in the README.md
-- build and run your app on an emulator or device
-
-## Test
-
-### Environment setup
-
-First, make sure you have installed the dependencies for the plugin by following the steps above.
-
-Then, make sure you have installed `react-native`.
-
-```
-npm install -g react-native
-```
-
-To run Android tests, make sure you have `sdk\tools`, `sdk\emulator` and  `sdk\platform-tools` in your PATH.
-
-To run iOS tests, make sure you've installed CocoaPods and have `.gem/bin` in your PATH.
-
-### Supported platforms
-
-The plugin has end to end tests for Android and iOS. Depending on your development machine OS, you can run some or all the tests.
-
-OS            | Supported tests
-------------- | -------------
-OS X          | Android, iOS
-Windows       | Android
-
-### Test descriptions
-
-The tests first build the app.
-
-They then check if the required emulators are currently running.
-
-If an Android emulator is not running, it attempts to boot the latest Android emulator. You can specify an emulator by adding env variable `ANDROID_EMU=yourEmulatorNameHere` to the npm command. For example: `ANDROID_EMU=yourEmulatorNameHere npm run test:android`.
-
-If an iOS simulator is not running, it attempts to boot the latest iOS iPhone simulator. You can specify a simulator by adding env variable `IOS_EMU=yourSimulatorNameHere` to the npm command. For example: `IOS_EMU="iPhone 8 (0567DFF8-329E-41A3-BD6D-E48E9DD5EF39)" npm run test:ios`.
-
-If all the required emulators are not running and the tests fail to boot them, the tests will fail.
-
-If you would like the tests to always restart the necessary emulators (killing them if they are currently running), setup a env variable `CLEAN=true` to the command. For example: `CLEAN=true npm run test`.
-
-The desired unit tests are then run.
-
-If you would like to skip building, add a `:fast` in the command you'd like to run. For example, `npm run test:ios` becomes `npm run test:fast:ios` or `npm run test:android` becomes `npm run test:fast:android`.
-
-There is a both a full unit test suite and a "core" set of unit tests that you may run. If you would like to run only the core tests, setup a env variable `CORE=true` to the command. For example: `CORE=true npm run test:android`.
-
-If you would like to pull the plugin from NPM rather than running the tests on the local version, setup a env variable `NPM=true` to the command. For example: `NPM=true npm run test:ios`.
-
-#### Default
-
-To run all of the unit tests on Android and iOS:
-```
-npm run test
-```
-
-#### iOS
-
-To run all of the unit tests on iOS:
-```
-npm run test:ios
-```
-
-#### Android
-
-To run all of the unit tests on Android:
-```
-npm run test:android
-```
-
-#### More examples
-
-All possible testing configurations have tasks!
-
-The platforms are ordered as follows, and ran in that order:
-android, ios
-
-To run the core unit tests on Android:
-```
-CORE=true npm run test:android
-```
-
-To run all of the unit tests on iOS and pull the plugin from NPM:
-```
-NPM=true npm run test:ios
-```
-
-To run all of the unit tests on Android and iOS without building first:
-```
-npm run test:fast
-```
-
-To run all of the unit tests on iOS and restart the emulators:
-```
-CLEAN=true npm run test:ios
-```
-
-To run the core unit tests on Android and pull the plugin from NPM:
-```
-NPM=true CORE=true npm run test:android
-```
-
-...and so on!