[Describe en una frase qué problema resuelve el proyecto y para quién.]
Plantilla: reemplaza el contenido entre corchetes, elimina las secciones que no apliquen y publica únicamente comandos que hayan sido verificados.
El estado de la entrega está en PLAN.md; la versión de la aplicación y su responsable, en SECURITY.md.
[Explica el objetivo, el alcance principal y los resultados esperados.]
- Runtime, versiones y herramientas: los fija STACK.md.
- [Acceso, servicio externo o credenciales requeridos]
- [Obtén el código fuente.]
- [Instala las dependencias.]
- [Crea y completa la configuración local desde la plantilla de entorno, si aplica.]
- [Inicia el entorno local.]
No incluyas secretos ni valores reales de producción en este repositorio.
| Tarea | Comando | Notas |
|---|---|---|
| Instalar dependencias | [comando] |
[cuándo ejecutarlo] |
| Desarrollo local | [comando] |
[URL o comportamiento esperado] |
| Validación | [comando] |
[lint, tipos o formato] |
| Pruebas | [comando] |
[alcance de la suite] |
| Compilación | [comando] |
[artefacto generado, si aplica] |
[Resume los componentes principales, sus responsabilidades y los límites con sistemas externos.]
[cliente o interfaz] -> [servicio o API] -> [datos o integraciones]
[directorio]/ # [responsabilidad]
[directorio]/ # [responsabilidad]
[directorio]/ # [responsabilidad]
- Producto: plataforma, usuarios, alcance, actores y reglas de negocio.
- Diseño: tokens de diseño normativos, experiencia, interfaz y criterios observables.
- Stack: stack elegido, runtime, versiones, dependencias y herramientas, incluidas las que fija la plantilla para los agentes.
- Plan: decisiones técnicas, fases, validación y avance verificado.
- Pendientes: detalle del trabajo pendiente registrado.
- Pruebas: cobertura observada, verificaciones completadas y referencias a trabajo pendiente.
- Bugs: registro de los bugs activos y cerrados del producto y su estado funcional.
- Seguridad: estado de seguridad de cada componente, vulnerabilidades y avisos, excepciones, remediaciones y referencias a riesgos pendientes.
- Añade aquí los enlaces a documentos de operación o arquitectura en
.readme/cuando existan.
[Resume qué niveles de prueba existen y enlaza la estrategia de validación en PLAN.md, la cobertura verificada en TESTS.md y el detalle de ejecución en .readme/.]
[Resume los entornos y enlaza el enfoque de entrega, observabilidad y recuperación en PLAN.md y el procedimiento ejecutable en .readme/.]
[Resume el flujo de ramas, revisión y convenciones, y enlaza las comprobaciones obligatorias a la estrategia de validación en PLAN.md.]
No se incluye una licencia por defecto. Añade el archivo raíz LICENSE únicamente cuando el titular seleccione y solicite explícitamente sus términos; documenta aquí el tipo, titular y enlace cuando aplique.