Descripción de PR para TDAH
Formato predeterminado del cuerpo del PR para este repositorio. Los revisores deberían poder terminar de leer la descripción de un vistazo. El diff ya está en GitHub — no vuelvas a indicar los movimientos de archivos.
Agentes: carguen esta habilidad cada vez que redacten o reescriban una descripción de PR de Nakama (incluso mediante ce-commit-push-pr). La forma del cuerpo proviene de aquí; aún así, recopilen las afirmaciones reales del diff (resultado, riesgo, qué verificaron).
Forma (obligatorio)
## Resumen
<una línea: quién hace qué → resultado. Sin niebla de jerga a menos que el cambio sea jerga.>
**Antes:** <una línea — comportamiento o coste anterior>
**Después:** <una línea — nuevo comportamiento; nombra la función/ruta clave si ayuda al riesgo>
Por qué es seguro:
1. <razón>
2. <razón>
3. <razón> <!-- 2–3 elementos como máximo; omite el #3 si no hay nada que decir -->
Solo rehacer / dar seguimiento si <un riesgo residual o desencadenante de reversión>.
## Plan de pruebas
- [x] <comando ya ejecutado> (<N> pasan)
- [ ] <una verificación manual que un humano pueda hacer en <2 min>
Opcional después del plan de pruebas (mantener si el flujo de trabajo espera las insignias de Compound Engineering):
---
[](https://github.com/EveryInc/compound-engineering-plugin)
Reglas
- Liderar = resultado. La primera línea del Resumen describe el nuevo mundo, no "Este PR elimina…".
- Antes/Después = dos líneas. Etiquetas en negrita. Sin párrafos envolviéndolas.
- Por qué es seguro = numerado, ≤3. Máximo 5 viñetas en total en cualquier parte del cuerpo; si hay más, conserva solo las que cambien la decisión.
- Un residual. Nombra el caso que te haría deshacer esto. Omítelo si realmente no hay ninguno.
- Sin turismo de diff. No enumeres archivos, recuentos de líneas como la historia, ni "también se limpiaron las exportaciones" a menos que eso sea el riesgo.
- Plan de pruebas = ejecutable. Prefiere comandos marcados con recuentos de pruebas que pasan; una sonda manual sin marcar.
- El título se mantiene convencional.
tipo(ámbito): imperativo— corto. El cuerpo lleva esta forma; el título no necesita emojis ni ensayos. - Aplicar con
gh. Escribe el cuerpo en un archivo temporal;gh pr edit <n> --body-file …ogh pr create --body-file …. Nunca--body "$(cat …)".
Ejemplo dorado
Que coincida con esta densidad:
## Resumen
Aprobar una propuesta de memoria de la organización → el elemento entra en `MEMORY.md`. Sin llamada LLM.
**Antes:** fusión determinista, luego reescritura opcional del modelo de todo el archivo.
**Después:** solo fusión determinista (`applyApprovedOrgMemoryBullet`).
Por qué es seguro:
1. La deduplicación + sustitución ya están activas en esa función
2. La ruta LLM ya falló de forma segura al resultado determinista
3. −230 líneas, mismo resultado de aprobación
Solo rehacer una reescritura LLM si elementos contradictorios comienzan a sobrevivir a la aprobación.
## Plan de pruebas
- [x] `bun test packages/agent/src` (80 pasan)
- [x] `bun test apps/server/src/services/org-memory-service.test.ts` (15 pasan)
- [ ] Aprobar una propuesta pendiente (anclada + registro reciente) — el elemento aterriza como antes
Antipatrones
| No hacer | Hacer |
|---|---|
| Resumen de varios párrafos | Una línea de resultado + Antes/Después + Por qué es seguro |
| "Este PR tiene como objetivo…" / "Con el fin de…" | Comenzar con el verbo o la acción del usuario |
### anidados dentro de Resumen | Solo ## Resumen + ## Plan de pruebas |
| Volver a indicar cada archivo eliminado | Solo riesgo residual |
| "las pruebas pasaron" vago | Comando exacto + recuento de pruebas |
Flujo de trabajo
- Leer el diff / los commits del PR (
gh pr view,git diff base...HEAD) - Nombrar: resultado, antes, después, ≤3 por qué es seguro, un residual
- Completar la plantilla — recortar cualquier frase que el diff ya demuestre
- Aplicar mediante
--body-file - Responder con la URL del PR (y "dime si quieres que ajuste el título" solo si es útil)