貢獻程式碼

若要參與 Appium 程式碼庫的貢獻，請務必查看 Git 儲存庫。

資訊

如果您是 VS Code 使用者，您可以使用 Runme 輕鬆查看專案。

建議在複製到系統之前先進行分岔。

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