diff --git a/contributing.md b/contributing.md new file mode 100644 index 00000000..1f91bbfd --- /dev/null +++ b/contributing.md @@ -0,0 +1,19 @@ +# Contributing + +- Tests are run against [appium's master branch](https://github.com/appium/appium/blob/master/docs/en/contributing-to-appium/appium-from-source.md) +- The tests are run using the [flaky gem](https://github.com/appium/flaky) on OS X +- The `arc` command can be run from within the `ios_tests` or `android_tests` folder to open an interactive console + +### Run iOS tests + +iOS tests are run on the iOS 8.1 iPhone simulator. + +- `cd ios_tests` +- `flake 3 ios` - Run all the iOS tests up to 3 times + +### Run Android tests + +Android tests require running on physical hardware. The emulator is unreliable. + +- `cd android_tests` +- `flake 3 android` - Run all the Android tests up to 3 times