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 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 ao registrar um problema no GitHub.
Depois de uma análise pela equipe principal do Bazel, ele será recomendado no site do Bazel.
Requisitos para os administradores de regras
- O conjunto de regras oferece um recurso importante, útil para um grande número de usuários do Bazel (por exemplo, suporte a uma linguagem muito conhecida).
- O conjunto de regras é bem mantido. É necessário 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 boa performance (consulte o guia de performance).
- 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 sempre precisam 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 devem 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 no head (pelo menos uma vez por dia).
- Nenhuma mudança no Bazel pode violar 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, registre um problema no GitHub.
Os administradores de regras vão receber uma mensagem e precisam responder em até duas semanas. Com base no resultado, a equipe principal do Bazel pode decidir rebaixar o conjunto de regras.