为 Bazel 相关项目命名

首先，感谢您为 Bazel 生态系统贡献力量！请通过 bazel-suite 邮寄名单与 Bazel 社区联系，分享您的项目及其建议名称。

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

为 Starlark 规则命名

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

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

为工具选择一个好的名称绝非易事。如果我们不小心，使用过多代号，新手可能会很难理解 Bazel 生态系统。

为 Bazel 工具命名时，请遵循以下准则：

  1. 不想引入新的品牌名称：“Bazel”Bazel已是我们的用户的新品牌，我们应该避免让用户与过多的新名称混淆。

  2. 更喜欢使用包含“Bazel”的名称：这有助于用户表明这是与 Bazel 相关的工具，还有助于用户通过搜索引擎找到它。

  3. 首选使用能够描述工具用途的名称：理想情况下，名称不需要添加副标题，以便用户能够初步了解该工具的用途。使用以空格分隔的英语单词是一种很好的方法。

  4. 并非必须使用花卉或食品主题：Bazel 会调用植物罗勒。您无需查找植物、食物或与“罗勒”相关的名称。

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

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

好名字示例：

  • 适用于 Eclipse 的 Bazel：用户会明白，如果他们想将 Bazel 与 Eclipse 搭配使用，应该在这里找到此选项。它使用第三方品牌作为描述词。
  • Bazel buildfarm：“buildfarm”是一种编译农场。用户会了解，此项目涉及在服务器上构建。

应避免使用的名称示例：

  • Ocimum：basil 的科学名称与 Bazel 项目无关。
  • Bazelizer：此名称后面的工具可以执行很多操作，因为此名称的描述性不足。

请注意，这些建议符合 Google 在开源项目时使用的指南。