Skip to main content

Título breve en imperativo

Cómo usar esta plantilla
  1. Copia este archivo a docs/adrs/NNNN-titulo-corto.md (numeración secuencial, 4 dígitos).
  2. Ajusta el frontmatter:
    • status: Proposed mientras se discute, Accepted al firmarse, Superseded cuando un ADR posterior lo reemplaza (en ese caso, descomenta superseded_by con el número del sucesor).
    • date: fecha de la decisión (o de la propuesta si aún está Proposed). Debe ir entre comillas para que YAML no la parsee como Date.
    • deciders: quienes firman la decisión. Usa handles de GitHub con @.
    • involved: quienes fueron consultados o contribuyeron pero no firman. Acepta también teams (@org/team).
    • discussion: no la escribas a mano. Este ADR nace de una GitHub Discussion (categoría Ideas). Cuando alguien comenta /adr en esa Discussion, el workflow adr-from-discussion bootstrapea este archivo con discussion: <número> ya lleno. La Discussion original queda como hilo permanente de follow-ups.
    • slug (opcional): añade slug: NNNN-titulo-corto si quieres que la URL conserve el prefijo numérico (Docusaurus lo elimina por defecto).
  3. Actualiza sidebar_label a algo tipo ADR-NNNN — Descripción corta.
  4. Borra este bloque :::instructions.
  5. Completa las secciones de abajo. El H1 y la metadata se renderizan automáticamente — no escribas # ADR-NNNN: ... ni listas manuales de Status/Date/Deciders; el frontmatter es la fuente de verdad.

Contexto​

Qué situación o problema estamos enfrentando. Incluir restricciones relevantes (técnicas, presupuestarias, temporales, organizacionales). Evitar prescribir la solución aquí.

Menciona a personas con @handle — se convierten automáticamente en links a su perfil de GitHub (ej. @andylow92).

Decisión​

Qué decidimos hacer, en una frase imperativa. Incluir los detalles suficientes para que un lector externo entienda el "qué" sin ambigüedad.

Consecuencias​

  • Lista plana de implicancias derivadas de la decisión, mezclando positivas, negativas y neutras.
  • Sé honesto con los costos: las consecuencias negativas también van aquí, no en un ADR aparte.
  • Si una consecuencia tiene mitigación clara, descríbela en la misma línea.

Alternativas evaluadas​

  • Alternativa A: descripción breve y por qué se rechazó.
  • Alternativa B: descripción breve y por qué se rechazó.

Referencias​

  • Enlaces a documentación, issues, PRs, artículos relevantes.