Como nomear um projeto relacionado ao Bazel

Primeiro, agradecemos por contribuir com o ecossistema do Bazel. Entre em contato com a comunidade do Bazel na lista de e-mails do bazel-discuss (em inglês) para compartilhar seu projeto e o nome sugerido dele.

Se você estiver criando uma ferramenta relacionada ao Bazel ou compartilhando suas regras do Skylark, recomendamos seguir estas diretrizes para o nome do seu projeto:

Como nomear regras de Starlark

Consulte Como implantar novas regras do Starlark nos documentos.

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 migrado de sistema de compilação.

Escolher um bom nome para sua ferramenta pode ser difícil. Se não tomarmos cuidado e usarmos muitos codinomes, o ecossistema do Bazel poderá se tornar muito difícil de entender para iniciantes.

Siga estas diretrizes para nomear ferramentas do Bazel:

  1. Prefira não apresentar um novo nome de marca: "Bazel" já é uma nova marca para nossos usuários. Por isso, precisamos evitar confundir os usuários com muitos nomes novos.

  2. 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.

  3. Prefira usar nomes que descrevam 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 primeira ideia boa do que a ferramenta faz. O uso de palavras em inglês separadas por espaços é uma boa maneira de fazer isso.

  4. Não é um requisito usar um tema floral ou alimentar: o Bazel evoca manjericão, a planta. Você não precisa procurar um nome que seja uma planta, alimento ou que se relacione a "manjericão".

  5. Se a ferramenta estiver relacionada a outra marca de terceiros, use-a apenas como 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. Obviamente, 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 entenderão que, se quiserem usar o Bazel com o Eclipse, essa será a opção certa. Ele usa uma marca de terceiros como descritor.
  • Bazel buildfarm: um "buildfarm" é um farm de compilação. Os usuários entenderão que este projeto está relacionado à criação em servidores.

Exemplos de nomes que devem ser evitados:

  • Ocimum: o nome científico do basil (link em inglês) não se relaciona o suficiente com o projeto do Bazel.
  • Bazelizer: a ferramenta por trás desse nome pode fazer muitas coisas. Esse nome não é descritivo o suficiente.

Observe que essas recomendações estão alinhadas com as diretrizes que o Google usa ao abrir o código de um projeto.