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