推奨ルール

このドキュメントでは、推奨ルールのリストを紹介しています。

これは一連の高品質なルールであり、ユーザーに優れたエクスペリエンスを提供します。Google では、サポートされているルールと、インターネット上にある数百のルールを区別しています。

ノミネート

ルールセットが以下の要件を満たしている場合、ルール管理者は GitHub の問題を提出して、そのルールを推奨ルールの一部として推薦できます。

Bazel コアチームによる審査後、Bazel ウェブサイトで推奨されます。

ルールの管理者の要件

  • ルールセットは、多数の Bazel ユーザーに役立つ重要な機能(たとえば、一般的な言語のサポートなど)を提供します。
  • ルールセットは適切に管理されています。アクティブなメンテナンス担当者が少なくとも 2 人必要です。
  • ルールセットがわかりやすくドキュメント化されており、例も紹介されていて、使い方も簡単です。
  • ルールセットはベスト プラクティスに従っており、パフォーマンスに優れています(パフォーマンス ガイドをご覧ください)。
  • ルールセットに十分なテスト カバレッジがある。
  • ルールセットは、BuildKite で最新バージョンの Bazel を使用してテストされています。テストは常に合格する必要があります(presubmit チェックとして使用する場合)。
  • このルールセットは、今後予定されている互換性のない変更でもテストされます。破損は 2 週間以内に修正されます。移行に関する問題は、速やかに Bazel チームに報告する必要があります。

Bazel デベロッパーの要件

  • 推奨ルールは、Bazel を使用して頻繁にテストされます(少なくとも 1 日に 1 回)。
  • Bazel を変更しても、(デフォルトのフラグセットによる)推奨されるルールに違反することはありません。発生した場合は、変更を修正するかロールバックします。

降格

特定のルールセットが要件を満たさなくなったと思われる場合は、GitHub の問題を報告してください。

ルールの管理者に連絡し、2 週間以内に回答する必要があります。その結果に基づいて、Bazel コアチームはルールセットの順位を下げる決定を下す可能性があります。