為 Bazel 相關專案命名

回報問題 查看原始碼 。 。 。 。 夜間。 。 7.37.2 。 。 7.1 。 。 7.0 。 。 6.5

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

如果您要建構 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 存放區網址。讀取存放區 網址應能幫助使用者瞭解這項工具的功能。當然,存放區 名稱只能使用破折號,而且不得使用空格和小寫英文字母。

適當名稱範例:

  • Eclipse 的 Bazel:使用者會瞭解是否要使用 Bazel 這就是他們該尋找的地方。使用第三方品牌 做為描述元
  • Bazel buildfarm:「buildfarm」是 編譯農場位使用者 能理解這項專案和在伺服器建構作業有關。

應避免使用的名稱包括:

  • Ocimum學名的科學名稱 與 Bazel 專案無關
  • Bazelizer:這個名稱背後的工具可以執行許多作業 不夠明確

請注意,這些最佳化建議符合 指南 Google 的開放研究領域,