Na documentação, fornecemos uma lista de regras recomendadas.
Esse é um conjunto de regras de alta qualidade que proporcionam uma boa experiência aos nossos usuários. Fazemos uma distinção entre as regras compatíveis e as centenas de regras que podem ser encontradas na Internet.
Indicação
Se um conjunto de regras atender aos requisitos abaixo, um responsável pela manutenção da regra poderá indicá-lo para fazer parte das regras recomendadas registrando um problema no GitHub.
Depois de uma análise da equipe principal do Bazel, ele será recomendado no site do Bazel.
Requisitos para os responsáveis pela manutenção da regra
- O conjunto de regras oferece um recurso importante, útil para um grande número de usuários do Bazel (por exemplo, suporte a um idioma amplamente popular).
- O conjunto de regras é bem conservado. É necessário que haja pelo menos dois responsáveis pela manutenção 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 sempre ser aprovados (quando usados como uma verificação de pré-envio).
- O conjunto de regras também é testado com as próximas mudanças incompatíveis. As falhas precisam ser corrigidas em até duas semanas. Os problemas de migração precisam ser informados à equipe do Bazel rapidamente.
Requisitos para desenvolvedores do Bazel
- As regras recomendadas são testadas com frequência no Bazel (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 um conjunto de regras específico não esteja mais atendendo aos requisitos, um problema do GitHub precisará ser registrado.
Os responsáveis pela manutenção da regra serão contatados e precisarão responder em duas semanas. Com base no resultado, a equipe principal do Bazel poderá tomar uma decisão de rebaixar o conjunto de regras.