Na documentação, fornecemos uma lista de regras recomendadas.
Esse é um conjunto de regras de alta qualidade que fornece uma boa experiência aos 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 pode indicá-lo para fazer parte das regras recomendadas registrando um problema do GitHub.
Após uma análise pela equipe principal do Bazel, ela será recomendada no site do Bazel.
Requisitos para os mantenedores 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 uma linguagem muito conhecida).
- O conjunto de regras está bem mantido. É preciso haver pelo menos dois administradores ativos.
- O conjunto de regras está bem documentado, com exemplos e fáceis de usar.
- O conjunto de regras segue as práticas recomendadas e é eficiente (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 falhas 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 na cabeça (pelo menos uma vez por dia).
- Nenhuma alteração no Bazel pode violar uma regra recomendada (com o conjunto padrão de sinalizações). Se isso acontecer, a mudança deve ser corrigida ou revertida.
Demonstração
Se houver uma preocupação de que um determinado conjunto de regras não atende mais aos requisitos, um problema do GitHub deve ser registrado.
Os administradores de regras vão entrar em contato e vão precisar responder em até duas semanas. Com base no resultado, a equipe principal do Bazel pode tomar a decisão de rebaixar o conjunto de regras.