Skip to content

Latest commit

 

History

History
56 lines (30 loc) · 2.21 KB

Note-for-developers.md

File metadata and controls

56 lines (30 loc) · 2.21 KB

IDE

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.

eclipse compiler

If you are using the Eclipse IDE, make sure you are using version Luna or later.

Coding Standards

Appium java-client strictly follows Google Java Style as a coding standards. Contributors are requested to follow this by configuring in their IDE's Editor Code style,

Intellij IDEA user's can configure this way, Files -> Other Settings -> Default Settings ->Editor -> Code Style -> Manage -> Manage -> Import -> eclipse-java-google-style.xml (Downloaded from Google Style Guide)-> Apply

Eclipse IDE user's can configure this way, Preferences -> Java -> Code Style -> Formatter -> Import -> eclipse-java-google-style.xml (Downloaded from Google Style Guide)-> Apply

Reformat your code before raising a Pull Request.

Code style

Please be careful with code style.

How to check the style of proposed code.

Execute the command

mvn clean site

After the finishing please go and open

{project__folder}/target/site/index.html

and then

and then

choose the Checkstyle. If there are errors please fix them. Please keep the count of warnings as minimal as it possible.

Code Coverage

jacoco-maven-plugin generates the coverage reports, once integration tests are successfully run by maven-surefire-plugin

Intellij IDEA user's can configure and view this way, 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