プルリクエストのチェック
The content of this page may be outdated and some links may be invalid.
A newer version of this page exists in
English. To see the changes to the English page since this page was last updated: visit
GitHub compare
548e5e29..56530751
and search for
More information ...
content/en/docs/contributing/pr-checks.md.
opentelemetry.io リポジトリにpull request（PR）を作成した際に、一連のチェックが実行されます。 PR のチェックは次のことを検証します。
- CLA の署名しているか
- PR がNetlify を通じてデプロイに成功しているか
- スタイルガイドに変更が従っているか
Note
もし何らかの PR チェックが失敗していれば、最初にローカルで npm run fix:all を実行することで内容の問題を修正してください。
PRに /fix:all というコメントを追加することもできます。
これにより、OpenTelemetry ボットが代わりにそのコマンドを実行して、PR を更新します。
ローカルに変更をプルすることを忘れないでください。
問題が残り続けている場合のみ、以下を読んで様々なチェックの内容と、失敗した状態からの修正する方法を確認してください。
Easy CLA
CLA に署名していなかった場合は、このチェックが失敗します。
Netlify deployment
Netlifyのビルドが失敗した場合は、詳細については Details を選択してください。
GitHub PR チェック
コントリビューションが スタイルガイド に従っていることを検証するために、スタイルガイドのルールを検証し、問題が見つかった場合に失敗する一連のチェックを実装しています。
後述のリストでは、現在のチェック内容と、それに関連するエラーを修正する方法について説明します。
TEXT linter
このチェックは、OpenTelemetry 固有の用語や単語がサイト全体で一貫して使用されていることを検証します。
問題が見つかった場合、プルリクエストの files changed ビューでファイルにアノテーションが追加されます。これらを修正すると、チェックが成功します。
また、npm run check:text -- --fix をローカルで実行すると、ほとんどの問題を修正できます。
npm run check:text を再度実行し、残りの問題を手動で修正してください。
MARKDOWN linter
このチェックは、Markdown ファイルの標準と一貫性が強制されていることを検証します。
問題が見つかった場合、npm run fix:format を実行すると、ほとんどの問題を修正できます。
より複雑な問題がある場合は、npm run check:markdown を実行し、提案された変更を適用してください。
SPELLING check
このチェックは、すべての単語が正しく綴られていること を検証します。
CSPELL check
このチェックは、cSpell の ignore リストに含まれるすべての単語が正規化されていることを検証します。
このチェックが失敗した場合、npm run fix:dict をローカルで実行し、新しいコミットの変更をプッシュしてください。
FILENAME check
このチェックは、すべてのファイルが Prettier によってフォーマットされていること を検証します。
このチェックが失敗した場合、npm run fix:format をローカルで実行し、新しいコミットで変更をプッシュしてください。
FILE FORMAT
このチェックは、すべてのファイル名が kebab-case になっていること を検証します。
このチェックが失敗した場合、npm run fix:filenames をローカルで実行し、新しいコミットで変更をプッシュしてください。
BUILD and CHECK LINKS
このチェックは、ウェブサイトをビルドしてすべてのリンクが有効であることを検証します。
ローカルでリンクをチェックするには、npm run check:links を実行してください。
このコマンドは参照キャッシュも更新します。
refcache に変更があれば、新しいコミットでプッシュしてください。
404 エラーの修正
リンクチェッカーによって invalid（HTTPステータス 404）として報告された URL を修正する必要があります。
有効な外部リンクの処理
リンクチェッカーは、チェッカーをブロックするサーバーによって、200（成功）以外の HTTP ステータスを取得することがあります。 このようなサーバーは、404 以外の 400 番台の HTTP ステータス（401、403、406 が最も一般的）を返すことがよくあります。 LinkedIn などの一部のサーバーは 999 を報告します。
チェッカーが成功ステータスを取得できない外部リンクを手動で検証した場合は、URL にクエリパラメーター?no-link-checkを追加して、リンクチェッカーに無視させることができます。
たとえば、https:/some-example.org?no-link-check はリンクチェッカーによって無視されます。
メンテナーは、リンクチェッカーを実行した直後に次のスクリプトを実行して、Puppeteer に成功ステータスでないリンクの検証を試みさせることができます。
./scripts/double-check-refcache-400s.mjs -f --max-num-to-update 99
このスクリプトは、リンクチェッカーが実行しない URL フラグメントも検証します。
WARNINGS in build log?
このチェックが失敗した場合、npm run log:check:links ステップの BUILD and CHECK LINKS ログを確認して、他の潜在的な問題を特定してください。
復旧方法がわからない場合は、メンテナーに助けを求めてください。
フィードバック
このページは役に立ちましたか?
Thank you. Your feedback is appreciated!
Please let us know how we can improve this page. Your feedback is appreciated!