プルリクエストのチェック

opentelemetry.io リポジトリにpull request（PR）を作成した際に、一連のチェックが実行されます。 PR のチェックは次のことを検証します。

• CLA の署名しているか
• Netlifyを通じて正常にデプロイしているか
• スタイルガイドに変更が従っているか

Easy CLA

CLA に署名していなかった場合は、このチェックが失敗します。

Netlify deployment

Netlifyのビルドが失敗した場合は、より詳細のために Details を選択してください。

スタイルチェック

コントリビューションが スタイルガイド に従っていることを検証するために、スタイルガイドのルールを検証し、問題が見つかった場合に失敗する一連のチェックを実装しています。

後述のリストでは、現在のチェック内容と、それに関連するエラーを修正する方法について説明します。

TEXT linter

このチェックは、OpenTelemetry 固有の用語や単語がサイト全体で一貫して使用されていることを検証します。

問題が見つかった場合、プルリクエストの files changed ビューでファイルにアノテーションが追加されます。これらを修正すると、チェックが成功します。 また、npm run check:text -- --fix をローカルで実行すると、ほとんどの問題を修正できます。 npm run check:text を再度実行し、残りの問題を手動で修正してください。

MARKDOWN linter

このチェックは、Markdown ファイルの標準と一貫性が強制されていることを検証します。

問題が見つかった場合、npm run:format を実行すると、ほとんどの問題を修正できます。 より複雑な問題がある場合は、npm run check:markdown を実行し、提案された変更を適用してください。

SPELLING check

このチェックは、すべての単語が正しく綴られていること を検証します。

CSPELL:IGNORE check

このチェックは、cSpell の ignore リストに含まれるすべての単語が正規化されていることを検証します。

このチェックが失敗した場合、npm run fix:dict をローカルで実行し、新しいコミットの変更をプッシュしてください。

FILENAME check

このチェックは、すべてのファイルが Prettier によってフォーマットされていること を検証します。

このチェックが失敗した場合、npm fix:format をローカルで実行し、新しいコミットで変更をプッシュしてください。

FILE FORMAT

このチェックは、すべてのファイル名が kebab-case になっていること を検証します。

このチェックが失敗した場合、npm fix:filenames をローカルで実行し、新しいコミットで変更をプッシュしてください。

BUILD and CHECK LINKS / REFCACHE updates?

このチェックは、コミットによって追加されたすべてのリンクが機能していることを検証します。

npm run check:links を実行して、ローカルでリンクを検証してください。 これにより参照キャッシュ (REFCACHE) も更新されます。 REFCACHE の変更があれば、新しいコミットでプッシュしてください。

WARNINGS in build log?

このチェックが失敗した場合、ビルドログを検証し、他の潜在的な問題を特定してください。 復旧方法がわからない場合は、メンテナーに助けを求めてください。