release v0.3.0 (origen c00f020)

2026-10-18 18:58:51 +02:00
commit 2df23d5b33
@@ -0,0 +1,27 @@
+# Secretos y configuración local
+.env
+.env.*
+!.env.example
+
+# Dependencias descargadas
+node_modules/
+vendor/
+venv/
+.venv/
+__pycache__/
+*.py[cod]
+
+# Artefactos de build
+dist/
+build/
+target/
+out/
+*.log
+logs/
+
+# Sistema operativo y editores
+.DS_Store
+Thumbs.db
+.idea/
+.vscode/
+*.swp
@@ -0,0 +1,88 @@
+# AGENTS.md
+
+Guía para agentes y colaboradores que trabajen en **{{PROYECTO}}**.
+Léela antes de tocar cualquier fichero y respétala en cada cambio.
+
+## Propósito del proyecto
+
+{{DESCRIPCION}}
+
+## Contenido del repositorio
+
+| Ruta | Descripción |
+| --- | --- |
+| `AGENTS.md` | Este documento: reglas de trabajo. |
+| `README.md` | Visión general y puesta en marcha. |
+| `INSTALL.md` | Instalación detallada y dependencias. |
+| `CHANGELOG.md` | Historial de cambios (*Keep a Changelog*). |
+| `TODO.md` | Tareas pendientes y deuda técnica. |
+| `.pi/settings.json` | Ajustes de pi del proyecto: modelo por defecto. |
+| _(completar)_ | Añade aquí el código y los recursos del proyecto. |
+
+## Reglas de modelo
+
+### Modelo por defecto
+
+El modelo por defecto del proyecto se guarda en `.pi/settings.json`
+(`defaultProvider` y `defaultModel`) y pi lo aplica al iniciar cada sesión nueva
+en este directorio (requiere haber confiado en el proyecto: `/trust`).
+
+- Para cambiarlo: `/modelo-proyecto` (muestra los modelos disponibles) o
+  `/modelo-proyecto proveedor/id`.
+- No edites a mano ni cambies ese modelo sin que lo pida el usuario.
+- `.pi/settings.json` se versiona; un cambio de modelo se commitea como
+  cualquier otro cambio.
+
+### Otras reglas
+
+PENDIENTE: definir el contexto y el criterio de selección de modelos por tarea
+(coste, VRAM, ventana, velocidad). Se acuerda tarea por tarea; hasta entonces,
+no fijar valores aquí.
+
+## Reglas de funcionamiento
+
+PENDIENTE: definir flujo de trabajo, estándares de código, comandos obligatorios,
+política de ramas y de revisión, y cualquier automatización propia del proyecto.
+
+## Reglas obligatorias
+
+1. **Todo cambio se documenta y se commitea.** Cada vez que se modifique
+   cualquier fichero del repositorio:
+   - Añadir una entrada en `CHANGELOG.md` (fecha, versión y tipo:
+     `Añadido` / `Cambiado` / `Corregido` / `Eliminado`).
+   - Actualizar `TODO.md` si el cambio abre, cierra o modifica tareas.
+   - Actualizar `README.md`, `INSTALL.md` o los documentos que correspondan si
+     cambia el comportamiento, la instalación o el uso.
+   - Crear **un commit de git** con mensaje claro en imperativo.
+2. **Nunca dejar documentación desfasada.** Si el código y los documentos no
+   coinciden, el cambio está incompleto.
+3. **No commitear** secretos, binarios, artefactos de build, logs ni dependencias
+   descargadas (`.gitignore` cubre lo básico; amplíalo según el stack).
+4. **Idioma: español** para documentación, mensajes de commit y comentarios.
+
+## Verificación antes de commitear
+
+PENDIENTE: sustituir por los comandos reales del stack (formato, tipos, tests,
+lint). Ningún commit sin verificación en verde.
+
+```bash
+# ejemplo
+# make check
+```
+
+## Flujo de trabajo
+
+1. Editar los ficheros necesarios.
+2. Ejecutar las verificaciones anteriores.
+3. Actualizar `CHANGELOG.md`, `TODO.md` y la documentación afectada.
+4. `git add -A && git commit -m "tipo(alcance): descripción breve"`.
+5. Informar del cambio y del hash del commit.
+
+## Convención de mensajes de commit
+
+`tipo(alcance): resumen` — tipos: `feat`, `fix`, `docs`, `chore`, `refactor`,
+`test`, `build`, `perf`.
+
+Ejemplos:
+- `docs: documentar instalación y puesta en marcha`
+- `feat(api): añadir búsqueda paginada`
@@ -0,0 +1,24 @@
+# Changelog
+
+Todos los cambios relevantes de este proyecto se documentan en este fichero.
+
+El formato sigue [*Keep a Changelog*](https://keepachangelog.com/es-ES/1.1.0/)
+y el proyecto usa [Versionado Semántico](https://semver.org/lang/es/).
+
+## [No publicado]
+
+### Añadido
+
+- Base documental inicial del proyecto ({{FECHA}}): `AGENTS.md`, `README.md`,
+  `INSTALL.md`, `CHANGELOG.md`, `TODO.md` y `.gitignore`.
+
+<!--
+Plantilla de entrada:
+
+## [0.1.0] - AAAA-MM-DD
+
+### Añadido
+### Cambiado
+### Corregido
+### Eliminado
+-->
@@ -0,0 +1,79 @@
+# INSTALL — {{PROYECTO}}
+
+Instalación, configuración y puesta en marcha de **{{PROYECTO}}**.
+
+{{DESCRIPCION}}
+
+## 1. Requisitos
+
+PENDIENTE: completar con el stack real.
+
+| Componente | Versión mínima | Notas |
+| --- | --- | --- |
+| Sistema operativo | PENDIENTE | |
+| Lenguaje / runtime | PENDIENTE | |
+| Gestor de paquetes | PENDIENTE | |
+| Otros | PENDIENTE | |
+
+Comprueba lo instalado:
+
+```bash
+# PENDIENTE: comandos de comprobación (p. ej. python3 --version)
+```
+
+## 2. Obtener el código
+
+```bash
+git clone <url-del-repositorio>
+cd {{PROYECTO}}
+```
+
+## 3. Dependencias
+
+```bash
+# PENDIENTE: instalación de dependencias
+```
+
+## 4. Configuración
+
+PENDIENTE: variables de entorno, ficheros de configuración y secretos. Indica
+qué ficheros hay que crear y de dónde copiarlos (`.env.example`, etc.).
+
+```bash
+# PENDIENTE: cp .env.example .env  y editar
+```
+
+| Variable | Obligatoria | Descripción |
+| --- | --- | --- |
+| PENDIENTE | | |
+
+## 5. Verificación de la instalación
+
+```bash
+# PENDIENTE: comando de humo que demuestre que funciona
+```
+
+## 6. Arranque
+
+```bash
+# PENDIENTE: comando de arranque en desarrollo y en producción
+```
+
+## 7. Actualización
+
+```bash
+git pull
+# PENDIENTE: reinstalar dependencias y aplicar migraciones si las hay
+```
+
+## 8. Desinstalación
+
+PENDIENTE: qué borrar y qué dejar.
+
+## 9. Resolución de problemas
+
+| Síntoma | Causa probable | Solución |
+| --- | --- | --- |
+| PENDIENTE | | |
+
+Documento creado el {{FECHA}} por {{AUTOR}}.
@@ -0,0 +1,58 @@
+# {{PROYECTO}}
+
+{{DESCRIPCION}}
+
+## Estado
+
+- Versión: `0.1.0`
+- Fecha de creación: {{FECHA}}
+- Autor: {{AUTOR}}
+- Estado: en desarrollo
+
+## Requisitos
+
+PENDIENTE: lenguajes, versiones y dependencias del sistema. Ver `INSTALL.md`.
+
+## Instalación rápida
+
+```bash
+# PENDIENTE: sustituir por los comandos reales
+git clone <url-del-repositorio>
+cd {{PROYECTO}}
+```
+
+Instrucciones completas en [`INSTALL.md`](INSTALL.md).
+
+## Uso
+
+PENDIENTE: ejemplo mínimo de uso o de arranque.
+
+```bash
+# PENDIENTE
+```
+
+## Estructura
+
+```text
+{{PROYECTO}}/
+├── AGENTS.md      # reglas de trabajo para agentes y colaboradores
+├── README.md      # este documento
+├── INSTALL.md     # instalación y dependencias
+├── CHANGELOG.md   # historial de cambios
+├── TODO.md        # tareas pendientes
+└── .pi/
+    └── settings.json  # modelo por defecto de pi (cambiar con /modelo-proyecto)
+```
+
+## Documentación
+
+| Documento | Contenido |
+| --- | --- |
+| [`AGENTS.md`](AGENTS.md) | Reglas, flujo de trabajo y convenciones. |
+| [`INSTALL.md`](INSTALL.md) | Instalación, configuración y desinstalación. |
+| [`CHANGELOG.md`](CHANGELOG.md) | Qué cambió y cuándo. |
+| [`TODO.md`](TODO.md) | Qué falta y qué está en curso. |
+
+## Licencia
+
+PENDIENTE: indicar licencia del proyecto.
@@ -0,0 +1,22 @@
+# TODO — {{PROYECTO}}
+
+Tareas pendientes y deuda técnica. Al cerrar una tarea, muévela a *Hecho* y
+anota el cambio en `CHANGELOG.md`.
+
+## En curso
+
+- [ ] _(nada en curso)_
+
+## Pendiente
+
+- [ ] Definir las **reglas de modelo** del proyecto en `AGENTS.md` (criterio por
+      tarea; el modelo por defecto se cambia con `/modelo-proyecto`).
+- [ ] Definir las **reglas de funcionamiento** del proyecto en `AGENTS.md`.
+- [ ] Completar los `PENDIENTE` de `README.md` e `INSTALL.md`.
+- [ ] Fijar los comandos de verificación reales en `AGENTS.md`.
+- [ ] Elegir licencia.
+
+## Hecho
+
+- [x] {{FECHA}} — base documental inicial (`AGENTS.md`, `README.md`, `INSTALL.md`,
+      `CHANGELOG.md`, `TODO.md`, `.gitignore`).