DescargableESMD23 oct
Plantilla de CLAUDE.md
Un punto de partida para dar contexto a un asistente de código: comandos, trampas conocidas, cómo verificar y límites.
plantilla-claude-md.md
MD · Tamaño 2,8 KB
Qué incluye
- Las siete secciones que de verdad cambian el comportamiento del asistente
- Notas en comentarios que explican qué poner en cada una
- Una lista de consejos para mantenerlo corto y útil
Vista previa
# CLAUDE.md — plantilla de partida > Fichero que un asistente de código (Claude Code y similares) lee al empezar cada sesión. > Úsalo para lo que el código NO te cuenta por sí solo. Cuanto más corto y más concreto, > mejor se respeta. Borra todas las notas `<!-- ... -->` cuando lo rellenes. > Plantilla de acastell.dev — https://acastell.dev/recursos --- ## Qué es este proyecto <!-- Dos o tres líneas: qué hace, para quién y qué lo hace especial. Nada de marketing. --> [Nombre]: [qué hace] para [quién]. Stack principal: [lenguaje, framework, base de datos]. ## Comandos <!-- Los que de verdad se usan. Que se puedan copiar y pegar. --> ```bash npm install # instalar dependencias npm run dev # servidor de desarrollo (puerto 3000) npm test # tests; deben pasar antes de dar nada por terminado npm run lint # lint npm run build # build de producción ``` ## Arquitectura (solo lo que no es obvio) <!-- No describas lo que se ve leyendo las carpetas. Cuenta lo que sorprende. --> - `src/lib/` — lógica de negocio sin dependencias de UI. - Los datos externos entran SIEMPRE por `[módulo]`; no llames a la API desde los componentes. - [Decisión no evidente y su motivo: «usamos X en lugar de Y porque ...»] ## Convenciones <!-- Solo las que el linter no puede imponer. --> - Nombres de [archivos / componentes / tests]: [convención]. - Errores: [cómo se gestionan y dónde se registran]. - Textos de interfaz en [idioma]; comentarios en [idioma]. ## Trampas conocidas <!-- La sección más valiosa. Cada cosa que ya te ha hecho perder una tarde. --> - [El puerto X lo usa otro servicio; no lo reutilices.] - [Esta variable de entorno debe estar definida o el build falla en silencio.] - [No toques `[carpeta]`: se genera automáticamente.] ## Cómo verificar antes de decir «hecho» 1. Ejecuta los tests y el lint y pega el resultado real. 2. Si el cambio es visible, compruébalo en el navegador; no basta con que compile. 3. Si no has podido comprobar algo, dilo de forma explícita en lugar de suponerlo. ## Límites <!-- Lo que el asistente no debe hacer sin preguntar. --> - No instales dependencias nuevas sin avisar y explicar por qué. - No toques `[archivos de configuración / migraciones / secretos]`. - No hagas push ni borres ramas sin que yo lo pida. - Cambios mínimos: no refactorices lo que no te he pedido. --- ### Consejos para mantenerlo útil - **Si una línea no cambiaría el comportamiento del asistente, bórrala.** Un fichero largo se cumple peor que uno corto. - Añade una línea cada vez que tengas que corregir al asistente por segunda vez lo mismo. - No pegues contenido que ya está en el código o en el README: enlázalo. - Revísalo cada pocas semanas; los comandos y los puertos cambian.
¿Te ha servido?
Cada día un Short nuevo y, cuando toca, un tutorial a fondo. Suscríbete y no te pierdas el siguiente.
