Skip to main content

Registro de cambios

Crono mantiene dos registros con propósitos distintos:

  • Registro de cambios para usuarios — describe, en lenguaje no técnico, las novedades de cada versión del producto (web y móvil). Es la sección Registro de cambios de esta documentación, pensada para que cualquier usuario entienda qué cambió.
  • Registro técnico (esta documentación) — la documentación técnica que estás leyendo, versionada junto con el código.

Versionado

Las versiones del producto siguen un esquema de tres números MAYOR.MENOR.PARCHE (por ejemplo, 1.13.4):

  • MAYOR — cambios grandes o incompatibles.
  • MENOR — funcionalidades nuevas compatibles hacia atrás.
  • PARCHE — correcciones y ajustes menores.

Los módulos tienen su propia versión en su modulo.json, independiente de la del núcleo, junto con VersionMinimaApp para declarar con qué versión de Crono son compatibles (ver Despliegue de módulos).

Cómo se registra un cambio

  • Los cambios de cara al usuario se resumen en el registro de cambios de usuario agrupados por versión.
  • Los cambios técnicos (nuevas APIs, contratos, convenciones) se reflejan en esta documentación, en la sección correspondiente.
  • Los cambios de esquema de datos quedan trazados en las migraciones con [MigracionVersion(...)], que son en sí mismas un historial versionado del modelo (ver Migraciones de base de datos).

Buenas prácticas

  • Escribe el registro de usuario en términos de beneficio, no de implementación ("Ahora puedes reordenar la ruta de cobranza", no "Se añadió PUT /reordenacion").
  • Mantén al día Version y VersionMinimaApp de cada módulo en cada entrega.
  • Para cambios incompatibles de la API, introduce una versión nueva del endpoint y documenta la migración (ver Cambios de versión).