Add contribution guide (#55)

Fixes #54

Signed-off-by: Zbynek Cervinka <[email protected]>

Author: zcervink

CONTRIBUTING.md

@@ -0,0 +1,70 @@
+# How to Contribute
+
+Thank you for your interest into contributing to the IntelliJ IDEA UI test library. Contributions are essential for expansion and growth of this project.
+
+
+## First Time Setup
+1) Install prerequisites:
+   * [Java Development Kit](https://adoptopenjdk.net/)
+2) Fork and clone the repository
+3) Import the folder as a project in JetBrains IntelliJ IDEA
+
+
+## Project Structure
+
+This project is structured into 5 main parts.
+
+### 1) Package <i>fixtures</i>
+Package <i>fixtures</i> contains several predefined fixtures that can be instantiated and used to access and work with the IntelliJ IDEA UI elements such as wizards, buttons, inputs and other parts of the IntelliJ IDEA IDE.
+
+### 2) Package <i>utils</i>
+
+Package <i>utils</i> contains static methods and constants that can be useful for writing IntelliJ IDEA UI tests. There are for example methods for taking sceenshots or creating new project without the need of implementing the whole process using provided fixtures.
+
+### 3) Package <i>exceptions</i>
+
+Package <i>exceptions</i> contains predefined exceptions for handling situation such as the object that I am creating fixture for does not exists or there is unrelevant or unsupported option passed into a method.
+
+### 4) Class <i>UITestRunner</i>
+
+* Class contains static methods for starting and closing IntelliJ IDEA for UI tests
+* Class contains public enum IdeaVersion defining supported IntelliJ IDEA versions
+* Class contains other public methods to work with the IntelliJ IDEA
+   * getIdeaVersion()
+   * getRemoteRobot()
+   * getRemoteRobotConnection()
+   <br>...
+
+### 5) The <i>test-project</i> folder
+
+The <i>test-project</i> folder contains simple test project with JUnit 5 tests.
+
+
+
+## Building the Library Locally
+
+For building the library locally run the following command in the root of the project. The project will be built and installed into your .m2 local repository.
+
+```
+$ ./gradlew publishToMavenLocal
+```
+
+
+## Running Tests
+
+To exeute the JUnit 5 tests run the following command:
+
+```
+$ cd ./src/test-project
+$ ./gradlew clean test
+```
+
+
+## Reporting Issues
+
+If you encounter a problem and know it is caused by the IntelliJ IDEA UI test library, please open an [issue report](https://github.com/redhat-developer/intellij-common-ui-test-library/issues). We really do appriciate any relevant issue report containg at least description and steps to reproduce the issue.
+
+
+## License
+
+This project is distributed under the Eclipse Public License - v 2.0 license. For more information see the [LICENSE](./LICENSE) file in the root of this repository.

README.md

@@ -2,12 +2,7 @@
 
 ### Add this library to an existing IntelliJ Plugin project
 
-1) Install the plugin to your local maven repository (use Java 8 to run the following cmd)
-```
-./gradlew publishToMavenLocal
-```
-
-2) Extend the build.gradle file of the IntelliJ Plugin repo
+1) Extend the build.gradle file of the IntelliJ Plugin repo
 
 ```
 sourceSets {
@@ -44,7 +39,7 @@ repositories {
 }
 ```
 
-3) Run and close the IntelliJ Idea before and after all the UI tests
+2) Run and close the IntelliJ Idea before and after all the UI tests
 ```
 private static RemoteRobot robot;
 
@@ -58,12 +53,3 @@ public static void closeIde() {
     UITestRunner.closeIde();
 }
 ```
-
-### Run JUnit tests to test this library
-
-You can run JUnit tests contained in this repository to test this library by executing the following command:
-
-```sh
-cd src/test-project
-./gradlew test
-```