為 Bazel 相關專案命名

首先，感謝您對 Bazel 生態系統的貢獻！請與 bazel-discuss 郵寄清單 上的 Bazel 社群聯絡，以分享您的專案及其建議名稱。

如果您正在建構 Bazel 相關工具或共用 Skylark 規則，建議遵循下列專案名稱設定專案名稱：

為 Starlark 規則命名

請參閱說明文件中的部署新的 Starlark 規則。

如果您正在建構一個能充實 Bazel 生態系統的工具，就適用本節。例如新的 IDE 外掛程式或新的建構系統遷移工具。

挑選好的名稱要用在工具上並不容易，如果我們未能謹慎使用過多程式碼名稱，Bazel 生態系統將對新手難以理解。

請按照下列指示為 Bazel 工具命名：

  1. 偏好未引入新的品牌名稱：「Bazel」已是使用者的新品牌，請避免使用過多新名稱而造成混淆。

  2. 請使用包含「Bazel」的名稱：這有助於表明這是 Bazel 的相關工具，也能讓使用者透過搜尋引擎找到。

  3. 最好使用能描述工具用途的描述性名稱：在理想情況下，名稱不應需要使用者清楚瞭解工具的用途。使用英文文字並以空格分隔，是達到這個目標的好方法。

  4. 您不需要使用花卉或食物主題：Bazel 會叫用「basil」這個植物。您不需要尋找植物、食物或「盆子」相關的名稱。

  5. 如果您的工具與其他第三方品牌相關，請僅做為描述元使用：舉例來說，請使用「Cmake 的 Bazel migrator」，而非「Cmake Bazel migrator」。

這些規範也適用於 GitHub 存放區網址。讀取存放區網址應幫助人們瞭解這項工具的用途。當然，存放區名稱可以縮短，且必須使用連字號，不能使用空格和小寫英文字母。

優良名稱範例：

  • Bazel for Eclipse：使用者應瞭解是否要透過 Eclipse 使用 Bazel，這應該是他們查看的位置。並以第三方品牌做為描述元
  • Bazel buildfarm：「buildfarm」是編譯設備。使用者會瞭解這項專案與在伺服器上建構有關。

應避免的名稱範例：

  • Ocimum：石盆的科學名稱對於 Bazel 專案沒有足夠的關聯性。
  • Bazelizer：這個名稱背後的工具可能執行許多作業，因此這個名稱不夠淺顯易懂。

請注意，這些建議符合 Google 針對專案開採的指南。