首先,感谢您为 Bazel 生态系统做出贡献!请通过 bazel-discuss 邮寄列表与 Bazel 社区联系,分享您的项目及其建议的名称。
如果您要构建与 Bazel 相关的工具或共享 Skylark 规则,我们建议您遵循以下项目名称准则:
命名 Starlark 规则
请参阅文档中的部署新的 Starlark 规则。
为其他与 Bazel 相关的工具命名
如果您要构建工具来丰富 Bazel 生态系统,则本部分适用。例如,新的 IDE 插件或新的构建系统迁移工具。
为工具选择一个合适的名称可能并非易事。如果我们不小心,使用了太多的代码名称,新手就可能会很难理解 Bazel 生态系统。
在命名 Bazel 工具时,请遵循以下准则:
最好不要引入新的品牌名称:“Bazel”对用户来说已经是一个新品牌,我们应避免使用过多的新名称来混淆用户。
最好使用包含“Bazel”的名称:这有助于表明该工具与 Bazel 相关,还能帮助用户通过搜索引擎找到该工具。
最好使用能描述工具用途的名称:理想情况下,名称不应需要副标题,用户一看就应该能大致猜出该工具的用途。使用以空格分隔的英语单词是实现此目的的好方法。
使用花卉或食物主题并非必需:Bazel 让人联想到植物 basil。您无需寻找与植物、食物或“罗勒”相关的名称。
如果您的工具与其他第三方品牌相关,请仅将其用作描述符:例如,请使用“适用于 Cmake 的 Bazel 迁移工具”,而不是“Cmake Bazel 迁移工具”。
这些准则也适用于 GitHub 代码库网址。阅读代码库网址应该有助于用户了解该工具的用途。当然,代码库名称可以更短,并且必须使用短划线,而不是空格和小写字母。
良好名称示例:
- 适用于 Eclipse 的 Bazel:用户会了解,如果他们想将 Bazel 与 Eclipse 搭配使用,就应该查看此处。它使用第三方品牌作为描述符。
- Bazel buildfarm:“buildfarm”是编译农场。用户会了解此项目与在服务器上构建相关。
应避免使用的名称示例:
- Ocimum:罗勒的拉丁学名与 Bazel 项目的关联度不够。
- Bazelizer:这个名称背后的工具可以执行很多操作,但这个名称的描述性不够。
请注意,这些建议符合 Google 在开源项目时遵循的准则。