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

避けるべき名前の例:

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

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