To contribute to the Appium code base make sure to check out the Git repository.
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.
git clone [email protected]:$GITHUB_USERNAME/appium.git
After cloning you can go ahead and install the project dependencies:
From here on there are several things you can do.
Start Appium in Dev-Mode¶
To test your changes you can run Appium in dev mode via:
The project maintains a set of different test variations you can run to verify the quality of the code.
eslint for static code analysis and linting. You can run these checks via:
You can also run tests for specific workspaces, e.g.:
Smoke and E2E¶
Deploy Docs Locally¶
You should be able to view the page at