為 Bazel 相關專案命名

回報問題 查看原始碼 Nightly · 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 遷移工具」，而非「Cmake Bazel 遷移工具」。

這些規範也適用於 GitHub 存放區網址。閱讀存放區網址有助於使用者瞭解這項工具的功能。當然，儲存庫名稱可以更短，但必須使用連字號，而非空格和小寫英文字母。

適當名稱的範例：

  • Eclipse 版 Bazel：使用者會知道，如果想在 Eclipse 中使用 Bazel，就應前往這個頁面。它使用第三方品牌做為描述符。
  • Bazel 建構農場：「buildfarm」是編譯農場。使用者會瞭解這個專案與在伺服器上建構相關。

以下是應避免使用的名稱示例：

  • Ocimum：羅勒的科學名稱與 Bazel 專案的關聯性不夠。
  • Bazelizer：這個名稱背後的工具可以執行許多操作，因此這個名稱不夠具描述性。

請注意，這些建議與 Google 在開放專案原始碼時使用的規範一致。