Nomear um projeto relacionado ao Bazel

Informar um problema Ver código-fonte

Primeiro, agradecemos a contribuição para o ecossistema do Bazel. Entre em contato com a comunidade do Bazel na lista de e-mails 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, siga estas diretrizes para o nome do seu projeto:

Como nomear regras Starlark

Consulte Como implantar novas regras do Starlark nos documentos.

Nesta seção, vamos criar uma ferramenta para enriquecer o ecossistema do Bazel. Por exemplo, um novo plug-in de ambiente de desenvolvimento integrado ou um novo migrador do sistema de compilação.

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

Siga estas diretrizes para nomear ferramentas do Bazel:

  1. Não introduza um novo nome de marca: Bazel já é uma nova marca para nossos usuários. Evite confundi-lo com muitos nomes novos.

  2. Use um nome que inclua "Bazel": isso ajuda a expressar que é uma ferramenta relacionada ao Bazel, além de ajudar as pessoas a encontrá-lo com um mecanismo de pesquisa.

  3. Use 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 adivinha sobre o que a ferramenta faz. Usar palavras em inglês separadas por espaços é uma boa maneira de fazer isso.

  4. Não é um requisito para usar um tema floral ou alimentar: 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 "migrador de Bazel para Cmake" em vez de "migrador de Bazel do CMake".

Essas diretrizes também se aplicam ao URL do repositório do GitHub. A leitura do URL do repositório precisa ajudar as pessoas a entender o que a ferramenta faz. 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, é aí que eles buscam. Ela usa uma marca de terceiros como descritor.
  • Buildfarm de bazel: um "farm de construção" é um fazenda de compilação. Os usuários então entendem que esse projeto está relacionado à criação em servidores.

Exemplos de nomes que devem ser evitados:

  • Ocimum: o nome científico do manjericão não é suficiente para o projeto do Bazel.
  • Bazelizer: a ferramenta por trás desse nome pode fazer muitas coisas, mas ele 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.