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

<ph type="x-smartling-placeholder"></ph> 問題を報告する ソースを表示 夜間 · 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Bazel エコシステムにご協力いただきありがとうございます。お問い合わせください Bazel コミュニティを bazel-discuss メーリング リスト。プロジェクトや提案された名前を共有できます。

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

Starlark ルールに名前を付ける

新しい Starlark ルールのデプロイをご覧ください。 ご覧ください。

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

ツールに適切な名前を付けるのは、簡単なことではありません。注意を怠っていて、 Bazel エコシステムが理解しにくくなる可能性があります。 確認しましょう

Bazel ツールの命名については、次のガイドラインに従ってください。

  1. 新しいブランド名を導入しない（例: 「Bazel」）すでに新しいブランドである 新しい名前を多用しすぎないようにする必要があります。

  2. 「Bazel」を含む名前の使用を優先する: これは、Bazel が優れていることを表現するのに役立ちます。 Bazel 関連のツールで、検索エンジンでも見つけやすくなっています。

  3. ツールの機能がわかるような名前を使うことをおすすめします。 ユーザーが最初にアクセスできる名前は、サブタイトルを必要としないのが理想的です。 考えてみましょう。スペースで区切った英語の単語は、 説明します。

  4. 花や食べ物のテーマを使用する必要はありません: Bazel による呼び出し バジルという植物です。必ずしも 植物、食べ物、または「バジル」に関連する名前を探します。

  5. 他のサードパーティ ブランドに関連するツールの場合は、 記述子: たとえば、「Cmake 用の Bazel migrator」を使用します。、 「Cmake Bazel migrator」

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

適切な名前の例:

  • Bazel for Eclipse: Bazel を使用したい場合に、ユーザーが理解できるようにします。 これが Eclipse による検出です。サードパーティのブランドが使用されている 使用します。
  • Bazel buildfarm: 「buildfarm」は コンパイル ファーム。ユーザー このプロジェクトがサーバー上での構築に関連していることを理解します。

避けるべき名前の例:

  • Ocimum: バジルの学名 Bazel プロジェクトとの関連性が十分ではありません。
  • Bazelizer: この名前の背後にあるツールは、さまざまなことができます。 説明が足りません

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