贡献代码

要为 Appium 代码库贡献代码，请确保检出 Git 仓库。

信息

如果您是 VS Code 用户，您可以使用 Runme 轻松检出项目。

建议您在克隆到系统之前先 fork。

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

克隆后，您可以继续安装项目依赖项

npm install

从这里开始，您可以做几件事。

监视文件¶

在开发 Appium 代码时，我们必须监视所有 JavaScript 和 TypeScript 文件，以便在每次更改后重新编译它们。您可以通过以下方式运行此监视过程

npm run dev

在开发模式下启动 Appium¶

要测试您的更改，您可以通过以下方式在开发模式下运行 Appium

npm start

运行测试¶

该项目维护着一组不同的测试变体，您可以运行这些变体来验证代码的质量。

代码风格检查¶

Appium 使用 eslint 进行静态代码分析和代码风格检查。您可以通过以下方式运行这些检查

npm run lint

单元测试¶

npm run test:unit

您还可以为特定工作区运行测试，例如

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

冒烟测试和 E2E 测试¶

npm run test:slow

在本地部署文档¶

我们的文档系统使用 MKDocs，因此需要在您的系统上安装 Python。您可以通过以下方式运行文档

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

您应该能够在 http://127.0.0.1:8000/docs/en 查看页面

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