為 Bazel 相關專案命名

回報問題 查看原始碼

首先,感謝您為 Bazel 生態系統貢獻心力!請透過 bazel-discuss 郵寄清單與 Bazel 社群聯絡,分享您的專案及其建議名稱。

如果您要建構 Bazel 相關工具或共用 Skylark 規則,建議您按照以下指南為專案名稱命名:

命名 Starlark 規則

請參閱文件中的部署新的 Starlark 規則一節。

如果您要建構工具來充實 Bazel 生態系統,則適用本節說明。例如新的 IDE 外掛程式或新的建構系統遷移工具。

為工具選擇合適的名稱並不容易。如果我們不小心謹慎地使用過多程式碼名稱,Bazel 生態系統可能會變得難以理解新進人員的概念。

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

  1. 最好不要導入新品牌名稱:「Bazel」已是使用者的新品牌,因此請避免使用過多新名稱,以免造成混淆。

  2. 建議使用包含「Bazel」的名稱:這有助於表示這是 Bazel 相關工具,也能協助使用者透過搜尋引擎找到該工具。

  3. 建議使用可明確描述工具名稱的名稱:在理想情況下,使用者不必擁有字幕就能讓工具對第一個功能做一件事。請用英文字詞分隔英文字詞。

  4. 不需使用花卉或食品主題:Bazel 會引發植物「Basil」的植物。您不需要尋找與「Basil」相關的植物、食物或名稱。

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

這些指南也適用於 GitHub 存放區網址。讀取存放區網址,可協助使用者瞭解工具的用途。當然,存放區的名稱可能會縮短,而且必須使用破折號取代空格和小寫英文字母。

良好名稱範例:

  • Eclipse 適用的 Bazel:使用者必須瞭解他們應該將 Bazel 與 Eclipse 搭配使用,才應該在這裡查看。並使用第三方品牌做為描述元
  • Bazel buildfarm:「buildfarm」是一個編譯農場。使用者會瞭解這項專案在伺服器上建構。

應避免的名稱範例:

  • Ocimumbasil 的科學名稱與 Bazel 專案無關。
  • Bazelizer:以這個名稱為基礎的工具可執行多項作業,不過名稱不夠精確。

請注意,這些建議與 Google 在開放專案採購時使用的指南保持一致。