Nombra un proyecto relacionado con Bazel

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 su nombre sugerido.

Si compilas una herramienta relacionada con Bazel o compartes tus reglas de Skylark, te recomendamos que sigas estos lineamientos para el nombre de tu proyecto:

Asigna nombres a las reglas de Starlark

Consulta Implementa reglas nuevas de Starlark en los documentos.

Esta sección se aplica si estás compilando una herramienta para enriquecer el ecosistema de Bazel. Por ejemplo, un nuevo complemento de IDE o un nuevo migrador de sistema de compilación.

Elegir un buen nombre para tu herramienta puede ser difícil. Si no tenemos cuidado y usamos demasiados 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:

  1. Te recomendamos no introducir un nuevo nombre de marca: "Bazel" ya es una marca nueva para nuestros usuarios. Debemos evitar confundirlos con demasiados nombres nuevos.

  2. Opta por usar un nombre que incluya “Bazel”: Esto ayuda a expresar que se trata de una herramienta relacionada con Bazel, también ayuda a las personas a encontrarla con un motor de búsqueda.

  3. Es preferible usar nombres descriptivos sobre lo que hace la herramienta: lo ideal es que el nombre no necesite un subtítulo para que los usuarios tengan una primera idea de lo que hace la herramienta. Usar palabras en inglés separadas por espacios es una buena manera de lograrlo.

  4. No es obligatorio usar un tema floral o alimentario: Bazel evoca la albahaca, la planta. No necesitas buscar un nombre que sea una planta o un alimento, o que se relacione con "albahaca".

  5. Si tu herramienta se relaciona con otra marca de terceros, úsala solo como descriptor: por ejemplo, usa “migrador de Bazel para Cmake” en lugar de “migrador de Cmake Bazel”.

Estos lineamientos también se aplican a la URL del repositorio de GitHub. Leer la URL del repositorio debería ayudar a las personas a comprender lo que hace la herramienta. Por supuesto, el nombre del repositorio puede ser más corto y debe usar guiones en lugar de espacios y letras minúsculas.

Ejemplos de buenos nombres:

  • Bazel para Eclipse: Los usuarios comprenderán que, si quieren usar Bazel con Eclipse, deben buscar aquí. Usa una marca de terceros como descriptor.
  • Buildfarm de Bazel: Un “buildfarm” es una granja de compilación. Los usuarios comprenderán que este proyecto se relaciona con compilar en servidores.

Ejemplos de nombres que se deben evitar:

  • Ocimum: El nombre científico de la albahaca no se relaciona lo suficiente con el proyecto de Bazel.
  • Bazelizer: La herramienta detrás de este nombre podría realizar muchas tareas; este nombre no es lo suficientemente descriptivo.

Ten en cuenta que estas recomendaciones están alineadas con los lineamientos que Google usa cuando crea un proyecto en código abierto.