Na documentação, fornecemos uma lista de regras recomendadas.
Esse é um conjunto de regras de alta qualidade que proporciona 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 mantenedor de regras poderá indicá-lo para fazer parte das regras recomendadas registrando um problema do GitHub.
Depois de uma revisão pela 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 para uma linguagem amplamente conhecida).
- O conjunto de regras é bem mantido. É preciso haver pelo menos dois mantenedores ativos.
- O conjunto de regras está bem documentado, com exemplos e fácil de usar.
- O conjunto de regras segue as práticas recomendadas e tem um 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 sempre ser 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 quebras devem ser corrigidas em até duas semanas. Os 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 cabeçalho (pelo menos uma vez por dia).
- Nenhuma alteração no Bazel pode violar uma regra recomendada (com o conjunto padrão de flags). Se isso acontecer, a alteração deve ser corrigida ou revertida.
Rebaixamento
Se houver uma preocupação de que um conjunto de regras específico não atenda mais aos requisitos, registre um problema do GitHub.
Os mantenedores da regra serão contatados e terão uma resposta em duas semanas. Com base no resultado, a equipe principal do Bazel pode decidir rebaixar o conjunto de regras.