コンテンツへスキップ

コードの貢献

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

テストの実行

プロジェクトでは、コードの品質を検証するために実行できるさまざまなテストバリエーションを維持しています。

Linting

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