为 Bazel 相关项目命名

报告问题 查看源代码 每夜版 · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

首先,感谢您为 Bazel 生态系统做出的贡献!请通过 bazel-discuss 邮件列表与 Bazel 社区联系,分享您的项目及其建议的名称。

如果您要构建与 Bazel 相关的工具或分享您的 Skylark 规则,我们建议您遵循以下项目名称准则:

命名 Starlark 规则

请参阅文档中的部署新的 Starlark 规则

如果您要构建用于丰富 Bazel 生态系统的工具,则本部分适用。 例如,新的 IDE 插件或新的 build 系统迁移器。

为工具选择一个好名称可能很难。如果我们不小心使用了过多的代号,那么对于新手来说,Bazel 生态系统可能会变得非常难以理解。

命名 Bazel 工具时,请遵循以下准则:

  1. 最好不要引入新品牌名称:“Bazel”对我们的用户来说已经是一个新品牌了,我们应避免使用过多的新名称来混淆他们。

  2. 最好使用包含“Bazel”的名称:这有助于表明该工具与 Bazel 相关,也有助于人们通过搜索引擎找到它。

  3. 最好使用能描述工具用途的名称:理想情况下,用户无需查看副标题就能大致了解工具的用途。使用以空格分隔的英文单词是实现此目的的好方法。

  4. 不一定非要使用花卉或食物主题:Bazel 让人联想到植物 basil(罗勒)。您无需寻找与植物、食物或“罗勒”相关的名称。

  5. 如果您的工具与另一个第三方品牌相关,请仅将其用作描述符:例如,使用“Bazel migrator for Cmake”而不是“Cmake Bazel migrator”。

这些准则也适用于 GitHub 代码库网址。阅读代码库网址应该有助于人们了解该工具的用途。当然,代码库名称可以更短,并且必须使用短划线而不是空格和小写字母。

优质名称示例:

  • Bazel for Eclipse:用户会明白,如果他们想将 Bazel 与 Eclipse 搭配使用,就应该查看此页面。它使用第三方品牌作为描述符。
  • Bazel buildfarm:“buildfarm”是编译农场。用户将了解此项目与在服务器上构建有关。

应避免使用的名称示例:

  • Ocimum罗勒的学名与 Bazel 项目的相关性不够。
  • Bazelizer:此名称背后的工具可以执行许多操作,但此名称不够描述性。

请注意,这些建议与 Google 在开源项目时使用的准则保持一致。