Sha256: 240aea8ec4ff4a53bc404ba6625700ffcd66f2ba31ef39f7c333593531700148
Contents?: true
Size: 1.61 KB
Versions: 12
Compression:
Stored size: 1.61 KB
Contents
# Contributing
For features or bug fixes, please submit a pull request. Ideally there would be a test as well. The remainder of this doc details how to run the tests.
If you'd like to adding new driver commands, please refer to https://github.com/appium/ruby_lib_core
## Tests
- 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 iPhone 6 / iOS 9.3 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 with Android 5.0 (API 21). The emulator is unreliable.
- `cd android_tests`
- `flake 3 android` - Run all the Android tests up to 3 times
## Publishing
0. Ensure you have `~/.gem/credentials` If not run [the following command](http://guides.rubygems.org/make-your-own-gem/) (replace username with your rubygems user)
> $ curl -u username https://rubygems.org/api/v1/api_key.yaml >
~/.gem/credentials; chmod 0600 ~/.gem/credentials
1. Bump the version number `rake bump`
2. Generate release note and create a branch with `rake release`
- Push and merge the branch to the master
3. Build and publish gem with `rake publish`
4. Add release information on GitHub: https://github.com/appium/ruby_lib/releases
- Template
```
### 1. Enhancements
### 2. Bug fixes
### 3. Deprecations
```
Version data entries
12 entries across 12 versions & 1 rubygems