Nombra un proyecto relacionado con Bazel

Informar un problema Ver fuente Noche {/2/}}

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 que sigas estos lineamientos para el nombre de tu proyecto:

Asigna nombres a las reglas de Starlark

Consulta Implementa reglas de Starlark nuevas en los documentos.

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 usamos demasiados nombres internos, el ecosistema de Bazel podría ser muy difícil de comprender para los principiantes.

Sigue estos lineamientos para asignar nombres a las herramientas de Bazel:

  1. Prefiero no presentar un nuevo nombre de marca: “Bazel” ya es una marca nueva para nuestros usuarios, por lo que debemos evitar confundirlos con demasiados nombres nuevos.

  2. Prefiere usar un nombre que incluya “Bazel”: Esto ayuda a expresar que es una herramienta relacionada con Bazel y a las personas también puede encontrarla con un motor de búsqueda.

  3. Es preferible usar nombres que describan lo que hace la herramienta: lo ideal es que el nombre no necesite un subtítulo para que los usuarios puedan tener una primera adivinación sobre lo que hace la herramienta. Usar palabras en español separadas por espacios es una buena manera de lograrlo.

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

  5. Si tu herramienta se relaciona con otra marca de terceros, úsala solo como descriptor. Por ejemplo, usa "Migrator Bazel para Cmake" en lugar de "Cmake Bazel migrator".

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í. Utiliza una marca de terceros como descriptor.
  • Farma de compilación de Bazel: Una “granja de compilación” es una granja de compilación. Los usuarios comprenderán que este proyecto se relaciona con la compilación en 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 realizar muchas acciones. El nombre no es lo suficientemente descriptivo.

Ten en cuenta que estas recomendaciones se alinean con los lineamientos que Google usa cuando crea un proyecto en código abierto.