为 Bazel 相关项目命名

<ph type="x-smartling-placeholder"></ph> 报告问题 查看来源 敬上 每晚 · 7.3。 · 7.2 条 · 7.1。 · 7.0。 · 6.5

首先,感谢您为 Bazel 生态系统贡献力量!请联系 有关 API 的 bazel-COMMENT 邮寄名单以共享您的项目及其建议的名称。

如果您要构建 Bazel 相关工具或共享 Skylark 规则, 我们建议您在命名项目时遵循以下准则:

为 Starlark 规则命名

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

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

为工具选择一个好名称可能并非易事。如果我们不够谨慎, 很多代号,那么 Bazel 生态系统可能会变得非常难以理解 新应用

请按照以下准则为 Bazel 工具命名:

  1. 最好不要引入新的品牌名称:“Bazel”已经是一个新品牌 因此,我们应避免将过多的新名称混淆在一起。

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

  3. 最好使用能够描述工具用途的名称: 理想情况下,该名称不需要添加副标题,用户就能一开始就看到好评 猜测工具的用途使用以空格分隔的英语单词 实现这一目标的方法。

  4. 我们不强制要求使用花卉或食物主题:Bazel 调用 basil,也就是植物。您无需 查找一个植物、食物或与“罗勒”有关的名称。

  5. 如果您的工具与其他第三方品牌相关,请仅将其用作 描述符:例如,使用“适用于 Cmake 的 Bazel 迁移器”而非 “Cmake Bazel 迁移器”。

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

良好名称的示例:

  • 适用于 Eclipse 的 Bazel:用户会了解,如果他们想要使用 Bazel 则应该在这里查看它使用第三方品牌 作为描述词。
  • Bazel buildfarm:“buildfarm”是 编译农场。用户 您将了解此项目与在服务器上构建应用有关。

应避免使用的名称示例:

  • Ocimum:罗勒的学名 与 Bazel 项目的关系不够紧密
  • Bazelizer:这个名称下面的工具可以做很多事,这个名称是 描述不够详细

请注意,这些建议与 准则 Google 在开放项目源代码时使用。