Como nomear um projeto relacionado ao Bazel

Reportar um problema Ver a fonte Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

Primeiro, agradecemos por contribuir com 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, recomendamos seguir estas diretrizes para o nome do seu projeto:

Como nomear regras Starlark

Consulte Como implantar novas regras do Starlark na documentação.

Esta seção se aplica se você estiver criando uma ferramenta para enriquecer o ecossistema do Bazel. Por exemplo, um novo plug-in de IDE 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 ficar muito difícil de entender para quem está começando.

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. Evite confundir eles 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 descritivos sobre o que a ferramenta faz: o ideal é que o nome não precise de um subtítulo para que os usuários tenham uma primeira 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 comida: o Bazel evoca manjericão, a planta. Não é necessário procurar um nome que seja uma planta, um alimento ou que se relacione a "manjericão".

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

Essas diretrizes também se aplicam ao URL do repositório do GitHub. Ler o URL do repositório ajuda as pessoas a entenderem o que a ferramenta faz. É claro que 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. Ela usa uma marca de terceiros como um descritor.
  • Buildfarm do Bazel: uma "buildfarm" é uma compile farm. Os usuários vão entender que este projeto está relacionado à criação em servidores.

Exemplos de nomes a serem evitados:

  • Ocimum: o nome científico do manjericão não está relacionado o suficiente ao projeto do Bazel.
  • Bazelizer: a ferramenta por trás desse nome pode fazer muitas coisas, mas o nome não é descritivo o suficiente.

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