Primeiro, agradecemos por contribuir com o ecossistema do Bazel. Entre em contato com a comunidade do Bazel 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 Skylark, recomendamos seguir estas diretrizes para o nome do seu projeto:
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 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:
Prefiro não apresentar um novo nome de marca: Bazel já é uma marca nova para nossos usuários, devemos evitar confundir com muitos nomes novos.
Prefira usar um nome que inclua "Bazel": isso ajuda a expressar que ele é uma ferramenta relacionada ao Bazel e ajuda as pessoas a encontrá-lo com um mecanismo de pesquisa.
Prefira usar nomes que descrevam o que a ferramenta faz: O ideal é que o nome não precise de subtítulo para que os usuários tenham uma primeira boa o que a ferramenta faz. Usar palavras em inglês separadas por espaços é uma boa para isso.
Não é obrigatório usar um tema floral ou de alimentos: o Bazel evoca manjericão, a planta. Você não precisa procure um nome que seja uma planta, um alimento ou que esteja relacionado a "manjericão".
Se sua ferramenta estiver relacionada a outra marca de terceiros, use-a somente como uma 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. Como ler o repositório O URL precisa ajudar as pessoas a entender o que a ferramenta faz. Claro, o repositório nome pode ser mais curto e deve usar travessões 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 Eclipse, é aqui que eles devem procurar. Ela usa uma marca de terceiros como um descritor.
- Bazel buildfarm: uma "fazenda" é um compile farm. 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 se relacionam o suficiente com o projeto Bazel.
- Bazelizer: a ferramenta por trás desse nome pode fazer muitas coisas. não é descritiva o suficiente.
Essas recomendações estão alinhadas diretrizes que o Google usa para abrir o código de um projeto.