Em primeiro lugar, agradecemos por contribuir com o ecossistema do Bazel. Entre em contato com a comunidade do Bazel na lista de discussão bazel-discuss para compartilhar seu projeto e o nome sugerido.
Se você estiver criando uma ferramenta relacionada ao Bazel ou compartilhando suas regras do Skylark, recomendamos seguir estas diretrizes para o nome do projeto:
Como nomear regras do Starlark
Consulte Como implantar novas regras do Starlark nos documentos.
Como nomear outras ferramentas relacionadas ao Bazel
Esta seção se aplica se você estiver criando uma ferramenta para enriquecer o ecossistema do Bazel. Por exemplo, um novo plug-in de ambiente de desenvolvimento integrado ou um novo migrador de sistema de build.
Escolher um bom nome para sua ferramenta pode ser difícil. Se não tomarmos cuidado e usarmos muitos codinomes, o ecossistema do Bazel pode se tornar muito difícil de entender para os novatos.
Siga estas diretrizes para nomear ferramentas do Bazel:
Não introduzir um novo nome de marca: "Bazel" já é uma nova marca para nossos usuários. Não devemos confundir os usuários com muitos nomes novos.
Prefira usar um nome que inclua "Bazel": isso ajuda a expressar que é uma ferramenta relacionada ao Bazel e também ajuda as pessoas a encontrá-la com um mecanismo de pesquisa.
Prefira usar nomes descritivos sobre o que a ferramenta está fazendo: o ideal é que o nome não precise de um subtítulo para que os usuários tenham uma boa primeira ideia do que a ferramenta faz. Usar palavras em inglês separadas por espaços é uma boa maneira de fazer isso.
Não é obrigatório usar um tema floral ou gastronômico: o nome "Bazel" faz referência à erva-príncipe, uma planta. Não é necessário procurar um nome que seja uma planta, alimento ou que se relacione com "basil".
Se a ferramenta estiver relacionada a outra marca de terceiros, use-a apenas como um descritor. Por exemplo, use "Bazel migrator for Cmake" em vez de "Cmake Bazel migrator".
Essas diretrizes também se aplicam ao URL do repositório do GitHub. A leitura do URL do repositório deve ajudar as pessoas a entender o que a ferramenta faz. Claro, o nome do repositório pode ser mais curto e precisa usar traços em vez de espaços e letras minúsculas.
Exemplos de bons nomes:
- Bazel para Eclipse: os usuários vão entender que, se quiserem usar o Bazel com o Eclipse, é aqui que eles precisam procurar. Ele usa uma marca de terceiros como descritor.
- Bazel buildfarm: um "buildfarm" é um farm de compilação. Os usuários vão entender que este projeto está relacionado à criação em servidores.
Exemplos de nomes a evitar:
- Ocimum: o nome científico do manjericão não tem relação suficiente com o projeto do Bazel.
- Bazelizer: a ferramenta por trás desse nome poderia fazer muitas coisas, mas o nome não é descritivo o suficiente.
Essas recomendações estão alinhadas às diretrizes que o Google usa ao abrir o código de um projeto.