Redacción de descripciones para Pull Requests

Explica el porqué del cambio y los puntos clave para el revisor

Prompt · 3 variables

Eres un desarrollador reconocido por redactar descripciones de Pull Request impecables. Tu prioridad absoluta es ahorrar tiempo al revisor.

La persona que leerá esto no conoce el contexto previo y ve este cambio por primera vez hoy. El método de prueba que utilicé es el siguiente: {{método de prueba}}

Lee las siguientes notas y la lista de archivos para redactar la descripción del Pull Request. Asegúrate de que se entienda el motivo del cambio antes que el detalle técnico de lo modificado.

Formato: Organízalo bajo estos cinco subtítulos: "Por qué se hizo el cambio · Qué cambia exactamente · Puntos clave para el revisor · Cómo probarlo · Fuera de alcance en este PR". Las dos primeras secciones deben tener un máximo de 3 líneas cada una; los "Puntos clave" deben ser una lista de máximo 3 elementos; e incluye un resumen de una sola frase al principio de todo.

No inventes métricas de rendimiento, números de incidencia (issue) ni fechas de despliegue que no haya mencionado. Si hay partes difíciles de determinar con mis notas, agrégalas al final bajo el encabezado "Dudas pendientes para el autor" con un máximo de 3 puntos.

Contenido del trabajo: """ {{contenido del trabajo}} """

Lista de archivos modificados: """ {{lista archivos modificados}} """

Copia y pégalo aquí · ChatGPT y Claude se abren con el prompt ya cargado Abrir en ChatGPT ↗Abrir en Claude ↗Abrir en Gemini ↗ Editar en el constructor Descargar tarjeta para clase

Por qué está escrito así

Rol
Eres un desarrollador reconocido por redactar descripciones de Pull Request impecables. Tu prioridad absoluta es ahorrar tiempo al revisor.
Contexto
La persona que leerá esto no conoce el contexto previo y ve este cambio por primera vez hoy. El método de prueba que utilicé es el siguiente: {{método de prueba}}
Tarea
Lee las siguientes notas y la lista de archivos para redactar la descripción del Pull Request. Asegúrate de que se entienda el motivo del cambio antes que el detalle técnico de lo modificado.
Formato
Formato: Organízalo bajo estos cinco subtítulos: "Por qué se hizo el cambio · Qué cambia exactamente · Puntos clave para el revisor · Cómo probarlo · Fuera de alcance en este PR". Las dos primeras secciones deben tener un máximo de 3 líneas cada una; los "Puntos clave" deben ser una lista de máximo 3 elementos; e incluye un resumen de una sola frase al principio de todo.
Restricciones
No inventes métricas de rendimiento, números de incidencia (issue) ni fechas de despliegue que no haya mencionado. Si hay partes difíciles de determinar con mis notas, agrégalas al final bajo el encabezado "Dudas pendientes para el autor" con un máximo de 3 puntos.
Material
Contenido del trabajo: """ {{contenido del trabajo}} """
Material
Lista de archivos modificados: """ {{lista archivos modificados}} """

Al redactar la descripción de un PR, la mayoría de la gente solo describe qué cambió. Sin embargo, la lista de archivos y el diff ya están a la vista. Lo que el revisor realmente no puede deducir es por qué se eligió esa solución concreta; sin esa explicación, la revisión suele empezar con un "¿por qué hiciste esto así?" y se pierde un día entero.

Definir el rol como "un desarrollador que ahorra tiempo al revisor" sirve para controlar la extensión. Sin esto, la IA genera un párrafo por cada archivo modificado, algo que nadie lee por completo. La línea de contexto que indica que "no conoce el contexto y lo ve por primera vez" elimina la jerga interna y las omisiones.

Los cinco subtítulos del formato son la columna vertebral de este prompt. En especial, "Puntos clave para el revisor" y "Fuera de alcance en este PR" son fundamentales. El primero enfoca la revisión y el segundo previene preguntas repetitivas como "¿por qué no arreglaste esto otro?". Por esta misma razón se limita la cantidad de líneas en cada sección.

La instrucción de no inventar datos es crucial al generar descripciones de PR con IA. Los modelos suelen añadir datos verosímiles pero falsos sobre rendimiento o números de issues, y el revisor los tomará como ciertos. En cambio, habilitar la sección "Dudas pendientes para el autor" canaliza cualquier incertidumbre sin inventar.

Solicitar el método de prueba como variable al inicio responde a la típica pregunta del revisor: "¿has probado esto?". Indicar claramente cómo se verificó permite al revisor replicar los pasos o señalar posibles casos no cubiertos.

¿Términos desconocidos? Consulta Aha AI: role-prompting, context-window

Comparado con un mal ejemplo

Mal ejemplo habitual

Escribe una descripción de PR para esto

(Pegar lista de archivos modificados)

Generará una simple lista que parafrasea los nombres de archivo. Leerlo aporta lo mismo que mirar el diff y, al no haber contexto, el revisor acabará preguntando por chat. Al no señalar dónde concentrar la atención, la revisión puede limitarse a corregir erratas o a una aprobación rápida sin análisis real.

Variaciones

Para correcciones urgentes (hotfix)

Para correcciones urgentes (hotfix)

Escribe una descripción breve para un Pull Request a partir de las notas siguientes. Incluye únicamente y en este orden: un resumen de una frase, el motivo de la urgencia en dos líneas, el método de prueba y cómo revertir el cambio (rollback). No agregues nada más. El método de prueba es: {{método de prueba}}

""" {{contenido del trabajo}} """

Ideal para incidencias donde urge desplegar y documentar después. Incluir "cómo revertir el cambio" es lo más importante en despliegues críticos.

Cuando tienes dudas para el revisor

Cuando tienes dudas para el revisor

Identifica en el siguiente contenido las decisiones técnicas sobre las que no estoy seguro y conviértelas en 3 preguntas concretas para el revisor. Para cada pregunta, añade una línea con la alternativa considerada y el motivo por el que elegí la opción actual. No decidas la respuesta por mí.

""" {{contenido del trabajo}} """

Útil cuando se abre un PR con dudas de arquitectura o diseño. Plantear las preguntas en la descripción orienta la revisión directamente a resolverlas.

Prompts relacionados

Última actualización 2026-09-02 · ¿Has visto un error? Avísanos