Bazel 関連プロジェクトに名前を付ける

まず、Bazel エコシステムにご協力いただき、ありがとうございます。bazel-discuss メーリング リストの Bazel コミュニティにお問い合わせのうえ、プロジェクトとその提案名を共有してください。

Bazel 関連ツールをビルドする場合、または Skylark ルールを共有する場合は、プロジェクトの名前について次のガイドラインに従うことをおすすめします。

Starlark ルールの命名

ドキュメントの新しい Starlark ルールのデプロイをご覧ください。

このセクションは、Bazel エコシステムを拡充するツールを構築している場合に該当する内容です。たとえば、新しい IDE プラグインや新しいビルドシステム移行ツールなどです。

ツールに適切な名前を選ぶのは簡単ではありません。コードネームが多すぎると、Bazel エコシステムを初めて使用する際に理解が難しくなることがあります。

Bazel ツールに名前を付ける際は、次のガイドラインに従ってください。

  1. 新しいブランド名を導入しないこと。「Bazel」はユーザーにとってすでに新しいブランドになっています。新しい名前を多くすることで混乱させないようにする必要があります。

  2. 「Bazel」を含む名前を使用する: これにより、Bazel 関連ツールであることが伝わりやすくなり、検索エンジンで見つけやすくなります。

  3. ツールの機能がわかるような名前を使用する: ツールの機能を理解しやすいように、名前にサブタイトルを付けないのが理想的です。英語の単語をスペースで区切ると 便利です

  4. 花や食べ物のテーマを使用する必要はありません。Bazel は、植物であるバジルを想起させます。植物や食品、「バジル」に関連する名前を探す必要はありません。

  5. ツールが別のサードパーティのブランドに関連する場合は、記述子としてのみ使用してください。たとえば、「Cmake Bazel migrator」ではなく「Bazel migrator for Cmake」を使用します。

このガイドラインは GitHub リポジトリの URL にも適用されます。リポジトリの URL を読むと、ツールの機能を理解しやすくなります。もちろん、リポジトリ名は短くできます。また、スペースや小文字の代わりにダッシュを使用する必要があります。

適切な名前の例:

  • Eclipse 用 Bazel: Eclipse で Bazel を使用する場合は、ここで確認する必要があります。説明として第三者のブランドを使用します
  • Bazel buildfarm: 「buildfarm」はコンパイル ファームです。このプロジェクトがサーバーでのビルドに関連していることをユーザーに理解できます。

避けるべき名前の例:

  • Ocimum: バジルの科学名が Bazel プロジェクトと十分に関連していません。
  • Bazelizer: この名前のツールはさまざまな処理を実行できますが、この名前では説明が不十分です。

これらの推奨事項は、Google がプロジェクトをオープンソース化する際に使用するガイドラインに準拠しています。