为 Bazel 相关项目命名

报告问题 查看源代码

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

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

为 Starlark 规则命名

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

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

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

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

  1. 最好不要引入新的品牌名称：“Bazel”已经是我们的用户的新品牌，我们应避免将其与太多新名称混淆。

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

  3. 最好使用能够说明该工具所做操作的名称：理想情况下，名称不需要字幕，用户应该首先猜出该工具的用途。使用英文单词以空格分隔是不错的方法。

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

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

这些指南同样适用于 GitHub 代码库网址。读取代码库网址应该有助于用户了解该工具的功能。当然，代码库名称可以更短，并且必须使用短划线，而不是空格和小写字母。

良好名称示例：

  • Bazel for Eclipse：用户知道，如果他们想将 Bazel 与 Eclipse 配合使用，则应该查看这部分信息。它使用第三方品牌作为描述符。
  • Bazel buildfarm：“buildfarm”是编译农场。用户将了解此项目与在服务器上构建相关。

应避免的名称示例：

  • Ocimum：罗勒的科学名称与 Bazel 项目的相关性不够高。
  • Bazelizer：此名称后面的工具可以执行很多操作，此名称不够描述性。

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