←Regresar

Convenciones establecidas para la creación y organización de repositorios en GitLab para los proyectos frontend.

La convención de nombres para todos los repositorios de los proyectos debe seguir estas reglas:

1. Usar PascalCase (UpperCamelCase): Todas las palabras comienzan con mayúscula, sin espacios o símbolos especiales.
2. Ser descriptivo pero conciso: El nombre debe indicar claramente el propósito del repositorio.
3. Evitar abreviaturas: Solo usar abreviaturas ampliamente reconocidas.
4. Prefijos especiales: Para ciertos tipos de proyectos (como microfrontends), se deben usar prefijos específicos.

• EventosFacturacionElectronica
• CertificadoReteFuente
• MFCajasMenores

• 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

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.

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.

←Regresar

Documento actualizado: 03/03/2025
Elaborado por: Luis Ardila - Desarrollador frontEnd