docs(readme): update readme & add contributing.md (#86)

radeva · web-flow · commit d2ccf5764455 · 2018-02-06T15:12:24.000+02:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,81 @@
+# Contributing to nativescript-dev-appium
+
+:+1: First of all, thank you for taking the time to contribute! :+1:
+
+Here are some guides on how to do that:
+
+<!-- TOC depthFrom:2 -->
+
+- [Code of Conduct](#code-of-conduct)
+- [Reporting Bugs](#reporting-bugs)
+- [Requesting Features](#requesting-features)
+- [Submitting a PR](#submitting-a-pr)
+- [Where to Start](#where-to-start)
+
+<!-- /TOC -->
+
+##  Code of Conduct
+Help us keep a healthy and open community. We expect all participants in this project to adhere to the [NativeScript Code Of Conduct](https://github.com/NativeScript/codeofconduct).
+
+
+## Reporting Bugs
+
+1. Always update to the most recent master release; the bug may already be resolved.
+2. Search for similar issues in the issues list for this repo; it may already be an identified problem.
+3. If this is a bug or problem that is clear, simple, and is unlikely to require any discussion -- it is OK to open an issue on GitHub with a reproduction of the bug including workflows and screenshots. If possible, submit a Pull Request with a failing test, entire application or module. If you'd rather take matters into your own hands, fix the bug yourself (jump down to the [Submitting a PR](#submitting-a-pr) section).
+
+## Requesting Features
+
+1. Use Github Issues to submit feature requests.
+2. First, search for a similar request and extend it if applicable. This way it would be easier for the community to track the features.
+3. When requesting a new feature, please provide as much detail as possible about why you need the feature in your apps. We prefer that you explain a need rather than explain a technical solution for it. That might trigger a nice conversation on finding the best and broadest technical solution to a specific need.
+
+## Submitting a PR
+
+Before you begin:
+* Read and sign the [NativeScript Contribution License Agreement](http://www.nativescript.org/cla).
+* Make sure there is an issue for the bug or feature you will be working on.
+
+Following these steps is the best way to get you code included in the project:
+
+1. Fork and clone the nativescript-dev-appium repo:
+```bash
+git clone https://github.com/<your-git-username>/nativescript-dev-appium.git
+# Navigate to the newly cloned directory
+cd nativescript-dev-appium
+# Add an "upstream" remote pointing to the original {N} repo.
+git remote add upstream https://github.com/NativeScript/nativescript-dev-appium.git
+```
+
+2. Set up the project:
+
+```bash
+#In the repo root
+npm install
+```
+
+3. Create a branch for your PR
+```bash
+git checkout -b <my-fix-branch> master
+```
+
+4. The fun part! Make your code changes. Make sure you:
+    - Follow the [NativeScript code conventions guide](https://github.com/NativeScript/NativeScript/blob/master/CodingConvention.md).
+
+5. Before you submit your PR:
+    - Rebase your changes to the latest master: `git pull --rebase upstream master`.
+    - Ensure your changes pass tslint validation. (run `npm run tslint` in the root of the repo).
+
+6. Push your fork. If you have rebased you might have to use force-push your branch:
+```
+git push origin <my-fix-branch> --force
+```
+
+7. [Submit your pull request](https://github.com/NativeScript/nativescript-dev-appium/compare). Please, fill in the Pull Request template - it will help us better understand the PR and increase the chances of it getting merged quickly.
+
+It's our turn from there on! We will review the PR and discuss changes you might have to make before merging it! Thanks! 
+
+
+## Where to Start
+
+If you want to contribute, but you are not sure where to start - look for [issues labeled `help wanted`](https://github.com/NativeScript/nativescript-dev-appium/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).
diff --git a/README.md b/README.md
@@ -2,22 +2,44 @@
 
 A package to help with writing and executing e2e [Appium](http://appium.io) tests.
 
-## <a name='requirements'></a>Requirments
+<!-- TOC depthFrom:2 -->
+
+- [Requirеments](#requirеments)
+- [Set Up](#set-up)
+    - [Structure](#structure)
+    - [Files Preview](#files-preview)
+- [Usage](#usage)
+- [Custom Appium Capabilities](#custom-appium-capabilities)
+- [Options](#options)
+- [Features](#features)
+- [Troubleshooting](#troubleshooting)
+- [Common Problems](#common-problems)
+- [Missing Features](#missing-features)
+- [Contribute](#contribute)
+- [Get Help](#get-help)
+
+<!-- /TOC -->
+
+## Requirеments
 
 The `nativescript-dev-appium` plugin requires:
 * latest version of [Appium](https://github.com/appium/appium/releases)
 * latest version of [Xcode](https://developer.apple.com/library/content/releasenotes/DeveloperTools/RN-Xcode/Chapters/Introduction.html)
 * [Android SDK Tools](https://developer.android.com/studio/releases/sdk-tools.html) version greater than 25.3.0
 
-## <a name='setup'></a>Set Up
+## Set Up
 
 Add the plugin as a `devDependency` to your project:
 
-`$ npm install -D nativescript-dev-appium`
+```shell
+$ npm install -D nativescript-dev-appium
+```
 
 Then install [Appium](https://www.npmjs.com/package/appium) - we recommend a global installation to avoid adding it to every project you would like to test:
 
-`$ npm install -g appium`
+```shell
+$ npm install -g appium
+```
 
 After completion of the installation, if your project has a dependency to *TypeScript*, the plugin should have added an `e2e` folder containing predefined configs and samples.
 
@@ -52,7 +74,7 @@ After completion of the installation, if your project has a dependency to *TypeS
 > * `e2e/reports` - this folder is created during test execution and stores the actual images from comparison
 > * `e2e/resources` - this folder aims to store the expected images for comparison
 
-## <a name='usage'></a>Usage
+## Usage
 
 Before running the tests you will have to build your app for the platform on test or both. Navigate to your demo app folder from where you will execute the commands that follow.
 
@@ -80,7 +102,7 @@ $ npm run e2e -- --runType sim.iPhone8.iOS110
 
 Generated tests are standard [Mocha](http://mochajs.org) tests.
 
-## <a name='customCapabilities'></a>Custom Appium Capabilities
+## Custom Appium Capabilities
 
 When installed, the plugin creates `e2e` folder containing sample test file and configuration folder `config` where your custom capabilities reside. 
 The existence of such capabilities is a runner's requirement which comes from [Appium](https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/caps.md). Additional locations where the runner will search for the config file are:
@@ -109,7 +131,7 @@ Thus, the same configuration can be used by both apps without duplication of fil
 
 If you wish to use another location of the capapabilities file instead default ones, you can specify it with `--capsLocation` option. Remember that the path provided has to be relative to the root directory.
 
-Notice that once custom capabilities are provided you will be able to pick any of them using the `--runType` option (e.g. `--runType android25`). Sample content of `appium.capabilities.json` file could be:
+Notice that once custom capabilities are provided you will be able to pick any of them using the `--runType` option (e.g. `--runType android25`). See sample content of `appium.capabilities.json` file below. For more details regarding the Appium Capabilities read [Appium documentation about Desired Capabilities](https://appium.io/docs/en/writing-running-appium/caps/):
 
 ```
 {
@@ -146,7 +168,7 @@ As you can see, the `app` property can be left an empty string which will force
 
 **It is important to build your app in advance as explained in [Usage](#usage) section, because the runner expects to provide app package to it or such to exists in the search location.**
 
-## <a name='options'></a>Options
+## Options
 
 |Option| Description | Value |
 |---|---|---|
@@ -186,9 +208,17 @@ $ npm run e2e -- --runType android25 --verbose
 ## Common Problems
 
 1. Missing installed appium
-2. Missleading appPath or capabilities location. Please make sure that the path to the app or capabilities location is correct.
+2. Misleading appPath or capabilities location. Please make sure that the path to the app or capabilities location is correct.
 
 
 ## Missing Features
 
 1. Faster developer turnaround when working on an app. Find a way to use livesync and kick off Appium tests for the app that's on the device already.
+
+## Contribute
+We love PRs! Check out the [contributing guidelines](CONTRIBUTING.md). If you want to contribute, but you are not sure where to start - look for [issues labeled `help wanted`](https://github.com/NativeScript/nativescript-dev-appium/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).
+
+## Get Help 
+Please, use [github issues](https://github.com/NativeScript/nativescript-dev-appium/issues) strictly for [reporting bugs](CONTRIBUTING.md#reporting-bugs) or [requesting features](CONTRIBUTING.md#requesting-features). For general questions and support, check out the [NativeScript community forum](https://discourse.nativescript.org/) or ask our experts in [NativeScript community Slack channel](http://developer.telerik.com/wp-login.php?action=slack-invitation).
+  
+![](https://ga-beacon.appspot.com/UA-111455-24/nativescript/nativescript-dev-appium?pixel) 
