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

問題を報告する ソースを表示 ナイトリー · 8.0 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

まず、Bazel エコシステムに貢献していただきありがとうございます。プロジェクトと推奨される名前を共有するには、bazel-discuss メーリング リストで Bazel コミュニティにお問い合わせください。

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

Starlark ルールの命名

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

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

ツールに適した名前を選ぶのは難しい場合があります。注意せずにコードネームを使いすぎると、Bazel エコシステムが新規ユーザーにとって非常に理解しづらくなる可能性があります。

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

  1. 新しいブランド名を導入しないことをおすすめします。「Bazel」はすでにユーザーにとって新しいブランドであるため、新しい名前を過度に増やして混乱を招かないようにする必要があります。

  2. 「Bazel」を含む名前を使用することをおすすめします。これにより、Bazel 関連のツールであることを明示できます。また、検索エンジンで見つけやすくなります。

  3. ツールの機能がわかる名前を使用することをおすすめします。理想的には、ユーザーがツールの機能を推測できるように、名前にサブタイトルが不要な状態にします。スペースで区切られた英語の単語を使用すると、この目的を達成できます。

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

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

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

適切な名前の例:

  • Bazel for Eclipse: Eclipse で Bazel を使用する場合は、ここを参照する必要があることをユーザーは理解しています。サードパーティのブランドを記述子として使用している。
  • Bazel buildfarm: 「buildfarm」はコンパイル ファームです。ユーザーは、このプロジェクトがサーバーで構築することに関連していることを理解します。

使用すべきでない名前の例:

  • Ocimum: バジルの学名は、Bazel プロジェクトと十分に関連していません。
  • Bazelizer: この名前のツールは多くのことを行えるため、この名前では十分に説明されていません。

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