Na documentação, fornecemos uma lista de regras recomendadas.
Este é um conjunto de regras de alta qualidade que proporcionará uma boa experiência aos nossos usuários. Fazemos uma distinção entre as regras compatíveis e as centenas de regras que você pode encontrar na Internet.
Indicação
Se um conjunto de regras atender aos requisitos abaixo, um administrador de regras poderá indicá-lo para fazer parte das regras recomendadas registrando um problema no GitHub.
Após revisão da equipe principal do Bazel, ela será recomendada no site do Bazel.
Requisitos para os mantenedores de regras
- O conjunto de regras fornece um recurso importante, útil para um grande número de usuários do Bazel. Por exemplo, suporte a uma linguagem amplamente conhecida.
- O conjunto de regras está bem mantido. É preciso ter pelo menos dois mantenedores ativos.
- O conjunto de regras é bem documentado, com exemplos e fácil de usar.
- O conjunto de regras segue as práticas recomendadas e tem bom desempenho (consulte o guia de desempenho).
- O conjunto de regras tem cobertura de teste suficiente.
- O conjunto de regras é testado 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).
- O conjunto de regras também é testado com as próximas alterações incompatíveis. As falhas precisam ser corrigidas em duas semanas. Problemas de migração devem ser relatados à equipe do Bazel rapidamente.
Requisitos para desenvolvedores do Bazel
- As regras recomendadas são frequentemente testadas com o Bazel no início (pelo menos uma vez por dia).
- Nenhuma alteração no Bazel pode quebrar uma regra recomendada (com o conjunto padrão de flags). Se isso acontecer, a alteração deverá ser corrigida ou revertida.
Rebaixamento
Se houver uma preocupação de que um determinado conjunto de regras não esteja mais atendendo aos requisitos, um problema no GitHub precisará ser registrado.
Os mantenedores das regras serão contatados e precisarão responder em duas semanas. Com base no resultado, a equipe principal do Bazel pode rebaixar o conjunto de regras.