推荐规则

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

这是一组优质规则,能够为我们的用户提供良好的体验。我们区分支持的规则和互联网上的数百条规则。

提名奖项

如果某个规则集符合以下要求,规则维护者可以通过提交 GitHub 问题来指定该规则集属于推荐规则

经过 Bazel 核心团队的审核后,系统会在 Bazel 网站上建议采用这种做法。

针对规则维护者的要求

  • 该规则集提供了一项对大量 Bazel 用户有用的重要功能(例如,支持一种广受欢迎的语言)。
  • 规则集维护良好。必须有至少两名活跃的维护者。
  • 该规则集记录得当,带有示例,易于使用。
  • 该规则集遵循最佳实践,并且性能出色(请参阅性能指南)。
  • 规则集具有足够的测试覆盖率。
  • 规则集使用最新版 Bazel 在 BuildKite 上进行测试。测试应始终通过(用作提交前检查时)。
  • 此外,系统还会使用即将发布的不兼容更改对规则集进行测试。中断应在两周内修复。迁移问题应快速报告给 Bazel 团队。

对 Bazel 开发者的要求

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

降位

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

我们会联系规则维护者,并在 2 周内回复。根据结果,Bazel 核心团队可能会决定对规则集进行降位。