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

問題を報告する ソースを表示 Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

まず、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」は compile farm です。ユーザーは、このプロジェクトがサーバーでのビルドに関連していることを理解します。

避けるべき名前の例:

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

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