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 がプロジェクトをオープンソース化する際に使用する ガイドラインに沿ったものです。