首先,感謝您對 Bazel 生態系統的貢獻!請透過 bazel-discuss 郵寄清單與 Bazel 社群聯絡,分享您的專案和建議名稱。
如果您要建構 Bazel 相關工具或分享 Skylark 規則,建議您遵循下列專案名稱規範:
命名 Starlark 規則
請參閱說明文件中的「部署新的 Starlark 規則」。
命名其他 Bazel 相關工具
如果您要建構工具來豐富 Bazel 生態系統,則適用本節內容。例如新的 IDE 外掛程式或新的建構系統遷移工具。
為工具命名可能不太容易,如果我們不小心使用過多代碼,新手可能會很難瞭解 Bazel 生態系統。
為 Bazel 工具命名時,請遵守下列規範:
盡量不要推出新品牌名稱:「Bazel」對使用者來說已是新品牌,我們應避免推出太多新名稱,以免造成混淆。
建議使用包含「Bazel」的名稱:這有助於表明這是 Bazel 相關工具,也能讓使用者透過搜尋引擎找到該工具。
建議使用能說明工具用途的名稱: 理想情況下,使用者應該不需要副標題,就能初步猜出工具用途。使用以空格分隔的英文字詞,是達成此目的的好方法。
不一定要使用花卉或食物主題:Bazel 讓人聯想到羅勒 (basil) 這種植物。你不需要尋找植物、食物或與「羅勒」相關的名稱。
如果工具與其他第三方品牌有關,請只將該品牌名稱做為描述符:舉例來說,請使用「Bazel migrator for Cmake」,而非「Cmake Bazel migrator」。
這些規範也適用於 GitHub 存放區網址。閱讀存放區網址應有助於使用者瞭解工具的用途。當然,存放區名稱可以較短,且必須使用破折號,而非空格和小寫英文字母。
名稱範例:
- 適用於 Eclipse 的 Bazel:使用者會瞭解,如果想搭配 Eclipse 使用 Bazel,就應該查看這個頁面。使用第三方品牌做為描述符。
- Bazel 建構農場:「建構農場」是「編譯農場」。使用者會瞭解這個專案與在伺服器上建構有關。
應避免的名稱範例:
- Ocimum:羅勒的學名與 Bazel 專案的關聯性不足。
- Bazelizer:這個名稱背後的工具可以執行許多動作,但這個名稱不夠具描述性。
請注意,這些建議與 Google 開放原始碼專案時使用的指南一致。