Primero, gracias por contribuir al ecosistema de Bazel. Comunícate con la comunidad de Bazel en la lista de distribución de bazel-discuss para compartir tu proyecto y el nombre sugerido.
Si compilas una herramienta relacionada con Bazel o compartes tus reglas de Skylark, te recomendamos seguir estos lineamientos para el nombre de tu proyecto:
Asigna nombres a las reglas de Starlark
Consulta Implementa reglas de Starlark nuevas. en los documentos.
Nombra otras herramientas relacionadas con Bazel
Esta sección se aplica si estás compilando una herramienta para enriquecer el ecosistema de Bazel. Por ejemplo, un complemento de IDE nuevo o un migrador de sistema de compilación nuevo.
Elegir un buen nombre para tu herramienta puede ser difícil. Si no tenemos cuidado y también usamos muchos nombres internos, el ecosistema de Bazel podría ser muy difícil de entender para los principiantes.
Sigue estos lineamientos para asignar nombres a las herramientas de Bazel:
Prefiero no presentar un nuevo nombre de marca: “Bazel”. ya es una marca nueva para nuestros usuarios, debemos evitar confundirlos con demasiados nombres nuevos.
Prefiere usar un nombre que incluya "Bazel": Esto ayuda a expresar que es una herramienta relacionada con Bazel, también ayuda a las personas a encontrarla con un motor de búsqueda.
Es preferible usar nombres que describan lo que hace la herramienta: Idealmente, el nombre no debería necesitar un subtítulo para que los usuarios tengan un primer elemento adivina qué hace la herramienta. Usar palabras en inglés separadas por espacios es una buena forma de lograrlo.
No es obligatorio usar un tema floral o de comida: Bazel evoca albahaca, la planta. No es necesario busca un nombre que sea una planta, un alimento o que se relacione con la "albahaca".
Si tu herramienta está relacionada con otra marca de terceros, úsala solo como descriptor: Por ejemplo, usa "Migrator de Bazel para Cmake". en vez de “Cmake Bazel migrator”.
Estos lineamientos también se aplican a la URL del repositorio de GitHub. Lee el repositorio La URL debe ayudar a las personas a comprender lo que hace la herramienta. Por supuesto, el repositorio el nombre puede ser más corto y debe incluir guiones en lugar de espacios y letras minúsculas.
Ejemplos de buenos nombres:
- Bazel para Eclipse: Los usuarios comprenderán que, si desean usar Bazel, con Eclipse, deberían buscar aquí. Usa una marca de terceros como descriptor.
- Farma de compilación de Bazel: Es una “granja de compilación” es un compile farm. Usuarios comprenderá que este proyecto se relaciona con la creación de servidores.
Ejemplos de nombres que debes evitar:
- Ocimum: el nombre científico de la albahaca no se relaciona lo suficiente con el proyecto Bazel.
- Bazelizer: La herramienta detrás de este nombre puede hacer muchas cosas. Ese nombre es no es lo suficientemente descriptivo.
Ten en cuenta que estas recomendaciones se alinean con el lineamientos Google utiliza cuando crea un proyecto en código abierto.