Nombra un proyecto relacionado con Bazel

Informar un problema Ver código fuente Nightly · 8.0 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

En primer lugar, gracias por contribuir al ecosistema de Bazel. Comunícate con la comunidad de Bazel en la lista de distribución 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:

Cómo nombrar reglas de Starlark

Consulta Cómo implementar nuevas reglas de Starlark en la documentación.

Esta sección se aplica si compilas una herramienta para enriquecer el ecosistema de Bazel. Por ejemplo, un nuevo complemento de IDE o un nuevo migrador de sistemas de compilación.

Elegir un buen nombre para tu herramienta puede ser difícil. Si no tenemos cuidado y usamos demasiados nombres en clave, el ecosistema de Bazel podría ser muy difícil de entender para los recién llegados.

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

  1. Preferimos 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. Se prefiere usar un nombre que incluya "Bazel": Esto ayuda a expresar que es una herramienta relacionada con Bazel y también ayuda a las personas a encontrarla con un motor de búsqueda.

  3. Usa nombres que describan lo que hace la herramienta: Lo ideal es que el nombre no necesite un subtítulo para que los usuarios tengan una primera idea clara 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 de comida: Bazel evoca el albahaca, la planta. No es necesario que busques un nombre que sea una planta, 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 "Bazel migrator for 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 qué 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, es aquí donde deben buscar. Usa una marca de terceros como descriptor.
  • Bazel buildfarm: Un "buildfarm" 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 se deben evitar:

  • Ocimum: El nombre científico del albahaca no se relaciona lo suficiente con el proyecto de Bazel.
  • Bazelizer: La herramienta detrás de este nombre podría hacer muchas cosas, pero no es lo suficientemente descriptiva.

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