Regras recomendadas

Informar um problema Ver a fonte Nightly · 8.0 · 7.4 · 7.3 · 7.2 · 7.1 · 7.0  · 6.5

Na documentação, fornecemos uma lista de regras recomendadas.

Esse é um conjunto de regras de alta qualidade, que vai proporcionar uma boa experiência aos usuários. Fazemos uma distinção entre as regras com suporte e as centenas de regras que você pode encontrar na Internet.

Indicação

Se um conjunto de regras atender aos requisitos abaixo, o administrador da regra poderá indicar que ele faz parte das regras recomendadas enviando um problema do GitHub.

Após uma análise da equipe principal do Bazel, ele será recomendado no site do Bazel.

Requisitos para os mantenedores de regras

  • A regra oferece um recurso importante, útil para um grande número de usuários do Bazel (por exemplo, suporte a uma linguagem muito conhecida).
  • A regra é bem mantida. É preciso ter pelo menos dois mantenedores ativos.
  • A regra é bem documentada, com exemplos e fácil de usar.
  • A regra segue as práticas recomendadas e tem bom desempenho (consulte o guia de performance).
  • A regra tem cobertura de teste suficiente.
  • A regra é testada no BuildKite com a versão mais recente do Bazel. Os testes precisam ser sempre aprovados (quando usados como uma verificação de pré-envio).
  • A regra também é testada com as próximas mudanças incompatíveis. As falhas devem ser corrigidas em até duas semanas. Os problemas de migração precisam ser informados rapidamente à equipe do Bazel.

Requisitos para desenvolvedores do Bazel

  • As regras recomendadas são testadas com frequência usando o Bazel na cabeça (pelo menos uma vez por dia).
  • Nenhuma mudança no Bazel pode quebrar uma regra recomendada (com o conjunto padrão de flags). Se isso acontecer, a mudança precisa ser corrigida ou revertida.

Rebaixamento

Se houver uma preocupação de que uma regra específica não atenda mais aos requisitos, será necessário registrar um problema do GitHub.

Os mantenedores das regras vão ser contatados e precisam responder em duas semanas. Com base no resultado, a equipe principal do Bazel pode decidir rebaixar o conjunto de regras.