Primero, ¡gracias por contribuir al ecosistema de Bazel! Comunícate con la comunidad de Bazel en la lista de distribución de Bazel 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 nuevas de Starlark en la documentación.
Asigna nombres a otras herramientas relacionadas con Bazel
Esta sección se aplica si compilas una herramienta para enriquecer el ecosistema de Bazel. Por ejemplo, un complemento de IDE nuevo o una nueva migración del sistema de compilación.
Elegir un buen nombre para su herramienta puede ser difícil. Si no somos cuidadosos y usamos demasiados nombres internos, el ecosistema de Bazel podría volverse muy difícil de entender para los principiantes.
Sigue estos lineamientos para nombrar las herramientas de Bazel:
Prefiere no ingresar un nombre de marca nuevo: "Bazel" ya es una marca nueva para nuestros usuarios; debemos evitar confundirlos con demasiados nombres nuevos.
Preferir 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
Preferir usar nombres descriptivos sobre lo que hace la herramienta: Lo ideal sería que el nombre no necesite un subtítulo para que los usuarios adivinen lo que 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 comida: Bazel evoca la albahaca, la planta. No necesitas buscar un nombre que sea una planta, un alimento o que esté relacionado con "albahaca".
Si tu herramienta se relaciona con otra marca de terceros, úsala solo como descriptor: Por ejemplo, usa "migrator de Bazel para Cmake" en lugar de "migrator 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 en minúscula.
Ejemplos de buenos nombres:
- Bazel para Eclipse: Los usuarios comprenderán que, si desean usar Bazel con Eclipse, es aquí donde deben buscar. Usa una marca de terceros como descriptor.
- Bazar 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 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 puede hacer muchas cosas, pero este nombre no es lo suficientemente descriptivo.
Ten en cuenta que estas recomendaciones están alineadas con los lineamientos que usa Google cuando se configura un proyecto de código abierto.