為 Bazel 相關專案命名

回報問題 查看來源

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

如果您要建構 Bazel 相關工具，或是共用 Skylark 規則，建議您遵循下列命名準則：

命名 Starlark 規則

請參閱文件中的「部署新的 Starlark 規則」。

為其他 Bazel 相關工具命名

本節適用於建構可豐富 Bazel 生態系統的工具。例如新的 IDE 外掛程式或新的建構系統遷移者。

為工具挑選一個好名稱並不容易，如果不謹慎且使用過多代號，新手 Bazel 生態系統可能會難以理解。

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

1. 偏好不要介紹新的品牌名稱：「Bazel」已經是我們使用者的新品牌，我們應該避免使用過多新名稱而造成混淆。

2. 最好使用包含「Bazel」的名稱：清楚表示這是 Bazel 的相關工具，也可協助使用者透過搜尋引擎找到 Bazel 的相關工具。

3. 建議您使用能描述工具用途的描述性名稱：理想上，名稱不應具備副標題，方便使用者瞭解這項工具的功能。以空格分隔的英文字詞是達成此目標的好方法。

4. 不一定要使用花卉或食物主題：Bazel 會抑制植物「基礎設施」。您不需要找出植物、食物或「基礎」相關的名稱。

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

這些規範也適用於 GitHub 存放區網址。讀取存放區網址應能幫助使用者瞭解這項工具的功能。當然，存放區名稱可以較短，而且必須使用破折號，而不是空格和小寫字母。

適當名稱範例：

• Eclipse 的 Bazel：使用者會瞭解如要將 Bazel 與 Eclipse 搭配使用，就會前往所需位置。以第三方品牌做為描述元。
• Bazel buildfarm：「buildfarm」是編譯農場。使用者會瞭解這項專案與在伺服器進行建構有關。

應避免使用的名稱包括：

• Ocimum：Science name of basil 與 Bazel 專案無關。
• Bazelizer：這個名稱背後的工具能夠執行許多作業，因此這個名稱不夠明確。

請注意，這些建議符合 Google 開放專案來源使用的指南。