|
1 | 1 | # IDE |
2 | 2 |
|
3 | | -If you are working on this project and use Intellij Idea, you need to change the compiler to the Eclipse compiler instead of the default javac. |
| 3 | +The **Intellij Idea** is recommended. |
4 | 4 |
|
5 | | - |
| 5 | +# Settings |
6 | 6 |
|
| 7 | +## Importing the project |
7 | 8 |
|
8 | | -If you are using the Eclipse IDE, make sure you are using version Luna or later. |
| 9 | +This is the Gradle project. |
9 | 10 |
|
10 | | -# Coding Standards |
| 11 | + |
11 | 12 |
|
12 | | -Appium java-client strictly follows [Google Java Style](http://google-styleguide.googlecode.com/svn/trunk/javaguide.html) as a coding standards. Contributors are requested to follow this by configuring in their IDE's Editor Code style, |
| 13 | +Be sure that: |
13 | 14 |
|
14 | | -* Clone [Google Style Guide](https://github.com/google/styleguide.git) from git |
| 15 | +- The `JAVA_HOME` environmental contains a path to JDK > 7 |
15 | 16 |
|
16 | | -**Intellij IDEA** user's can configure this way, |
17 | | -`Files -> Other Settings -> Default Settings ->Editor -> Code Style -> Manage -> Manage -> Import -> eclipse-java-google-style.xml (Downloaded from Google Style Guide)-> Apply` |
| 17 | +- If non built-in gradle distribution is used then its version should be > 2.1 |
18 | 18 |
|
19 | | -**Eclipse IDE** user's can configure this way, |
20 | | -`Preferences -> Java -> Code Style -> Formatter -> Import -> eclipse-java-google-style.xml (Downloaded from Google Style Guide)-> Apply` |
| 19 | +## Compiler |
21 | 20 |
|
22 | | -Reformat your code before raising a Pull Request. |
| 21 | +This project is compiled in some not common way. We use `ecj` Eclipse Java Compiler. Below is the sample how to define this compiler by IDE. |
| 22 | + |
23 | 23 |
|
24 | | -# Code style |
| 24 | +## JDK |
25 | 25 |
|
26 | | -Please be careful with code style. |
| 26 | +Please check following settings: |
27 | 27 |
|
28 | | -## How to check the style of proposed code. |
| 28 | + |
29 | 29 |
|
30 | | -Execute the command |
| 30 | + |
31 | 31 |
|
32 | | -`mvn clean site` |
| 32 | + |
33 | 33 |
|
34 | | -After the finishing please go and open |
35 | | - |
36 | | -`{project__folder}/target/site/index.html` |
| 34 | + |
37 | 35 |
|
38 | | -and then |
| 36 | + |
39 | 37 |
|
40 | | - |
| 38 | +## Coding Standards |
41 | 39 |
|
42 | | -and then |
| 40 | +Appium java-client strictly follows [Google Java Style](http://google-styleguide.googlecode.com/svn/trunk/javaguide.html) as a coding standards. Contributors are requested to follow this by configuring in their IDE's Editor Code style, |
43 | 41 |
|
44 | | - |
| 42 | +* Clone [Google Style Guide](https://github.com/google/styleguide.git) from git |
45 | 43 |
|
46 | | -choose the `Checkstyle`. If there are errors please fix them. Please keep the count of warnings as minimal as |
47 | | -it possible. |
| 44 | +**Intellij IDEA** users can configure this way, |
| 45 | +`Files -> Other Settings -> Default Settings ->Editor -> Code Style -> Manage -> Manage -> Import -> eclipse-java-google-style.xml (Downloaded from Google Style Guide)-> Apply` |
| 46 | + |
| 47 | +Reformat your code before raising a Pull Request. |
48 | 48 |
|
49 | | - |
50 | 49 |
|
51 | | -# Code Coverage |
| 50 | +## Code Coverage |
52 | 51 |
|
53 | 52 | `jacoco-maven-plugin` generates the coverage reports, once integration tests are successfully run by `maven-surefire-plugin` |
54 | 53 |
|
55 | 54 | **Intellij IDEA** user's can configure and view this way, |
56 | | -`Analyse -> show coverage Data -> Add -> Select ${basedir}/target/coverage-reports/jacoco-unit.exec (jacoco-unit.exec generated after integration test run) -> Click Show Selected -> Coverage Results displayed in IDE` |
| 55 | +`Analyse -> show coverage Data -> Add -> Select ${basedir}/target/coverage-reports/jacoco-unit.exec (jacoco-unit.exec generated after integration test run) -> Click Show Selected -> Coverage Results displayed in IDE` |
| 56 | + |
| 57 | +# Please do not forget to check the code before the pull-request proposal. |
| 58 | + |
| 59 | +It is needed to go to the directory where `java_client` is located. You can do it via command line. And then run the following command |
| 60 | + |
| 61 | +`gradle check`. If everything is ok then all checks should be passed. Otherwise you can open reports at `JAVA_CLIENT_DIRECTORY/build/reports` |
| 62 | + |
| 63 | +**The adding of new tests is required when new feature is added or some bug is fixed.** |
0 commit comments