Tabla de Contenidos
Crear repositorios en GitLab
Convenciones establecidas para la creación y organización de repositorios en GitLab para los proyectos frontend.
1. Convención de Nombres
La convención de nombres para todos los repositorios de los proyectos debe seguir estas reglas:
- Usar PascalCase (UpperCamelCase): Todas las palabras comienzan con mayúscula, sin espacios o símbolos especiales.
- Ser descriptivo pero conciso: El nombre debe indicar claramente el propósito del repositorio.
- Evitar abreviaturas: Solo usar abreviaturas ampliamente reconocidas.
- Prefijos especiales: Para ciertos tipos de proyectos (como microfrontends), se deben usar prefijos específicos.
Ejemplos correctos:
- EventosFacturacionElectronica
- CertificadoReteFuente
- MFCajasMenores
Ejemplos incorrectos:
- Eventos-facturacion-electronica - (usa guiones en lugar de PascalCase)
- certificadoReteFuente - (comienza con minúscula, no es PascalCase)
- mfcmen - (demasiado abreviado, poco claro)
IMPORTANTE: Los repositorios que contienen microfrontends deben tener el Prefijo “MF” seguido por el nombre en PascalCase
- MFCajasMenores
- MFCompromisos
- MFDisponibilidades
2. Descripciones de Repositorios
Cada repositorio debe tener una descripción clara y concisa que explique el propósito principal del proyecto preferiblemente de una sola oración o un párrafo corto.
3. Organización por Grupos
Los repositorios deben organizarse siguiendo una estructura jerárquica basada en los módulos a los que pertenecen, se debe evitar colocar repositorios en el nivel raíz sin un grupo asociado.
Documento actualizado: 03/03/2025
Elaborado por: Luis Ardila - Desarrollador frontEnd