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 を読むことで、ツールの機能を理解できます。もちろん、リポジトリ名は短くすることができ、スペースの代わりにダッシュを使用し、小文字にする必要があります。

適切な名前の例:

  • Bazel for Eclipse: ユーザーは、Eclipse で Bazel を使用したい場合、この名前のツールを探せばよいことがわかります。サードパーティ ブランドを記述子として使用しています。
  • Bazel buildfarm: 「buildfarm」は コンパイル ファームです。ユーザーは、このプロジェクトがサーバーでのビルドに関連していることを理解できます。

避けるべき名前の例:

  • Ocimum: バジルの学名は、Bazel プロジェクトとの関連性が 十分ではありません。
  • Bazelizer: この名前のツールは多くのことを行う可能性がありますが、名前は 十分に説明的ではありません。

これらの推奨事項は、Google がプロジェクトをオープンソース化する際に使用する ガイドライン に沿ったものです。