Documentación de DIXI Spec Kit English · Código en GitHub

/dixi.contract

Propósito

Definir o cambiar un contrato y su impacto en consumidores.

Escribir el contrato (API, eventos, CLI o schema) del objetivo de $ARGUMENTS, enlazado a sus consumidores.

Generada por scripts/build-command-reference.py a partir del texto empaquetado del comando; no la edites a mano.

Invocación

Argumento: <ID de módulo o feature>. Los signos de menor y mayor marcan un valor obligatorio y los corchetes uno opcional. En los pasos, $ARGUMENTS es el texto escrito después del comando.

Ejemplo

El texto después del comando es la petición; cámbialo para que corresponda a tu proyecto.

Cuándo usarlo

Pasos

  1. Ejecuta dixi workflow prepare contract --target <ID> --request "<interfaz a definir o cambiar>" y sigue sus pasos.
  2. Escribe o actualiza 07-contracts/<slug>.md con entradas, salidas, errores, límites y versión.
  3. Si el cambio rompe compatibilidad, márcalo explícitamente y lista los consumidores afectados; propone la migración y pide decisión a la persona.
  4. Registra el contrato en .dixi/traceability.json (kind: contract, con la feature o el módulo como padre).
  5. Indica qué pruebas de contrato faltan, sin escribirlas aquí.
  6. Sugiere /dixi.threat-model o /dixi.plan.

Archivos que lee y escribe

Rutas que nombra el texto del comando:

Paradas y controles humanos

Cierre

Ejecuta dixi check antes de terminar e informa: archivos tocados, comprobaciones (ejecutadas, fallidas, no ejecutadas), pendientes y el siguiente comando sugerido.

Siguiente paso

Relacionado