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 bazel-discuss (link em inglês) para compartilhar seu projeto e o nome sugerido.

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

Nomear regras do 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 do ambiente de desenvolvimento integrado ou um novo migrador do 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 ficar muito difícil de entender para os recém-chegados.

Siga estas diretrizes para nomear ferramentas do Bazel:

  1. Prefira não apresentar um novo nome de marca: "Bazel" já é uma marca nova para nossos usuários, precisamos evitar confundi-los 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 boa ideia do que a ferramenta faz. Usar palavras em inglês separadas por espaços é uma boa maneira de fazer isso.

  4. Não é obrigatório usar um tema floral ou de alimentos: o Bazel evoca o manjericão, a planta. Você não precisa procurar um nome que seja uma planta, um alimento ou que esteja relacionado a "manjericão".

  5. Se a ferramenta estiver relacionada a outra marca de terceiros, use-a apenas como descritor: por exemplo, use "Bazel migrator para Cmake" em vez de "Cmake Bazel Mimigtor".

Essas diretrizes também se aplicam ao URL do repositório do GitHub. A leitura do URL do repositório ajuda 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, precisam procurar aqui. Ela usa uma marca de terceiros como descritor.
  • Bazel buildfarm: uma "buildfarm" é um farm de compilação. Os usuários vão entender que este projeto está relacionado à criação em servidores.

Exemplos de nomes que devem ser evitados:

  • 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 pode fazer muitas coisas, o 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.