Contributing Code

To contribute to the Appium code base make sure to check out the Git repository.

Info

If you are VS Code user you can easily check out the project using Runme.

It is advised to fork before cloning it to your system.

export GITHUB_USERNAME=<your-username>
git clone [email protected]:$GITHUB_USERNAME/appium.git

After cloning you can go ahead and install the project dependencies:

npm install

From here on there are several things you can do.

Watch Files¶

When developing Appium code we have to watch all JavaScript and TypeScript files to re-compile them after every change. You can run this watch process via:

npm run dev

Start Appium in Dev-Mode¶

To test your changes you can run Appium in dev mode via:

npm start

Run Tests¶

The project maintains a set of different test variations you can run to verify the quality of the code.

Linting¶

Appium uses eslint for static code analysis and linting. You can run these checks via:

npm run lint

Unit¶

npm run test:unit

You can also run tests for specific workspaces, e.g.:

export APPIUM_WORKSPACE=@appium/doctor
npm run test:unit -w $APPIUM_WORKSPACE

Smoke and E2E¶

npm run test:slow

Deploy Docs Locally¶

Our documentation system uses MKDocs and therefore requires Python to be installed on your system. You can run the docs by:

# installing needed Python dependencies
PIP_BREAK_SYSTEM_PACKAGES=1 pip install -r packages/docutils/requirements.txt
# build the project
npm run build
# run dev server
npm run dev:docs

You should be able to view the page at http://127.0.0.1:8000/docs/en:

open http://127.0.0.1:8000/docs/en