推荐规则

在文档中,我们提供了一份 推荐规则列表。

这是一组优质规则,可为我们的用户提供良好的体验。我们区分受支持的规则和您可在网上找到的数以百计的规则。

提名

如果规则集满足以下要求,规则维护者可以提名该规则集 ,使其成为 推荐规则 的一部分,方法是提交 GitHub 问题

Bazel 核心团队 审核后,该规则集 将在 Bazel 网站上获得推荐。

对规则维护者的要求

  • 规则集提供了一项重要功能,对大量 Bazel 用户很有用(例如,支持一种广受欢迎的语言)。
  • 规则集维护良好。必须至少有两位活跃的维护者。
  • 规则集文档完善,包含示例,且易于使用。
  • 规则集遵循最佳实践,且性能良好(请参阅 性能指南)。
  • 规则集具有足够的测试覆盖率。
  • 规则集在 BuildKite 上使用最新版本的 Bazel 进行测试。(用作 a 预提交检查时)测试应始终通过。
  • 还会使用即将发布的不兼容变更来测试规则集。不兼容的部分应在两周内修复。应尽快向 Bazel 团队报告迁移问题。

对 Bazel 开发者的要求

  • 建议的规则会经常使用 Bazel 的 Head 分支进行测试(至少每天一次)。
  • Bazel 中的任何更改都不得破坏推荐的规则(使用默认标志集 )。如果发生这种情况,应修复或回滚更改。

降级

如果有人担心特定规则集不再满足 要求,应提交 GitHub 问题

我们会联系规则维护者,他们需要在 2 周内做出回应。根据结果,Bazel 核心团队可能会决定降级该规则集。