Solicitudes de cambio de arquitectura - Archyl Docs

Proponga, revise y fusione cambios en su modelo C4 a traves de un flujo estructurado de solicitudes de cambio

Solicitudes de cambio de arquitectura

Las solicitudes de cambio de arquitectura le permiten proponer modificaciones a su modelo C4 a traves de un flujo de revision estructurado. En lugar de editar la arquitectura directamente, los miembros del equipo crean solicitudes que pueden ser revisadas, discutidas y fusionadas.

Como funciona

Una solicitud de cambio agrupa una o mas modificaciones propuestas a su modelo de arquitectura. Sigue un ciclo de vida similar a un pull request en repositorios de codigo:

  1. Crear una solicitud con un titulo y una descripcion
  2. Agregar cambios — crear, actualizar o eliminar elementos C4 (sistemas, contenedores, componentes, elementos de codigo, relaciones, overlays)
  3. Abrir para revision cuando la propuesta este lista
  4. Revisar — los miembros del equipo aprueban, solicitan cambios o dejan comentarios
  5. Fusionar para aplicar todos los cambios a la arquitectura

Ciclo de vida de una solicitud

Cada solicitud pasa por estos estados:

Estado Descripcion
Borrador Trabajo en progreso. Solo el autor puede ver y editar los cambios.
Abierta Enviada para revision. Los miembros del equipo pueden revisar y comentar.
Aprobada Ha recibido aprobaciones y esta lista para fusionar.
Fusionada Los cambios se han aplicado al modelo de arquitectura.
Cerrada Rechazada o abandonada. El autor puede reabrirla.

Crear una solicitud

Desde la pestana Solicitudes

  1. Navegue a su proyecto
  2. Abra la pestana Solicitudes
  3. Haga clic en Nueva solicitud
  4. Ingrese un titulo (maximo 200 caracteres) y una descripcion opcional
  5. La solicitud comienza en estado Borrador

Agregar cambios

Dentro de una solicitud en borrador o abierta, agregue cambios seleccionando:

  • Operacion: Crear, Actualizar o Eliminar
  • Tipo de elemento: Sistema, Contenedor, Componente, Codigo, Relacion u Overlay
  • Datos del elemento: Las propiedades del elemento nuevo o modificado

Los cambios se agrupan por tipo de operacion (creaciones, actualizaciones, eliminaciones) para facilitar la revision.

Editar una solicitud

El autor puede editar el titulo y la descripcion de una solicitud en cualquier momento, siempre que no haya sido fusionada. Haga clic en el icono de lapiz junto al titulo para entrar en modo de edicion.

Revisar una solicitud

Enviar una revision

Los miembros del equipo con acceso de edicion pueden revisar solicitudes abiertas:

  • Aprobar — la propuesta es satisfactoria
  • Solicitar cambios — se necesitan modificaciones antes de fusionar
  • Comentar — dejar retroalimentacion sin una decision formal

Feed de actividad

La pestana de actividad muestra todas las revisiones y comentarios en orden cronologico. Use el compositor de comentarios en la parte inferior para dejar comentarios rapidos sin una revision formal.

Fusionar una solicitud

Cuando una solicitud ha sido revisada y aprobada:

  1. Abra la pagina de detalle de la solicitud
  2. Haga clic en Fusionar
  3. Todos los cambios se aplican atomicamente al modelo C4

Solo los miembros del equipo con permisos de edicion pueden fusionar solicitudes.

Previsualizar cambios

La pestana Vista previa muestra una representacion visual de como se vera la arquitectura despues de aplicar los cambios, para que los revisores comprendan el impacto antes de fusionar.

Buenas practicas

Escriba titulos claros

Use titulos descriptivos que expliquen la intencion:

  • "Agregar servicio de pagos e integracion con Stripe"
  • "Dividir la API monolitica en servicios de usuario y pedidos"
  • "Eliminar el componente de notificacion obsoleto"

Mantenga las solicitudes enfocadas

  • Un cambio logico por solicitud
  • Evite mezclar modificaciones no relacionadas
  • Las solicitudes mas pequenas son mas faciles de revisar

Use las descripciones

Explique el razonamiento detras de los cambios propuestos:

  • Por que es necesario este cambio arquitectonico
  • Que alternativas se consideraron
  • Enlaces a ADR o documentacion relacionada

Revise antes de fusionar

  • Se recomienda al menos una aprobacion
  • Use los comentarios para discutir compromisos
  • Verifique la pestana de vista previa para validar el resultado

Proximos pasos