Escribe una descripción de PR que un revisor pueda usar
Objetivo: permitir que un revisor decida en dos minutos qué mirar, y que un lector futuro entienda por qué existe el cambio.
Recopilar
- Encuentra la rama base y ejecuta
git log --oneline <base>..HEADygit diff --stat <base>...HEAD, luego lee el diff. - Busca el motivo: número de incidencia o ticket en los commits o en el nombre de la rama, la solicitud del usuario, comentarios añadidos en el diff. Si el motivo no está en ninguno de estos, pregúntale al usuario; no inventes una motivación.
- Verifica qué se probó: archivos de prueba en el diff y comandos que el usuario ejecutó. Si no se ejecutaron pruebas, dímelo claramente.
- Busca un
.github/pull_request_template.mdoPULL_REQUEST_TEMPLATE. Si existe, complétalo en lugar de usar la estructura siguiente.
Estructura
<Título: imperativo, menos de 70 caracteres, nombra el cambio de comportamiento, no los archivos>
## Por qué
<El problema o la solicitud, en 1 a 3 oraciones. Enlaza la incidencia si la hay.>
## Qué cambió
- <Bullets a nivel de comportamiento agrupados por área, no una lista de archivos.>
## Cómo revisar
- Empieza con <archivo o área>; el resto se sigue de ahí.
- Parte riesgosa: <la parte con más probabilidad de estar equivocada, y por qué>.
- No cambiado a propósito: <cualquier cosa que un revisor pueda esperar y no encontrará>.
## Pruebas
- <Comandos exactos ejecutados y resultados.>
- <Pasos manuales y lo que se observó. "No probado: ..." si corresponde.>
## Despliegue / riesgo
<Migraciones, configuración, feature flags, compatibilidad, cómo revertir. "Ninguno" solo si es cierto.>
Reglas
- Describe lo que hace el diff, no lo que te gustaría que hiciera. Vuelve a leer el diff después de redactar y elimina cualquier afirmación que no respalde.
- No enumeres cada archivo. Enumera cambios de comportamiento, nueva configuración, nuevas dependencias y código eliminado.
- Sin relleno ("Este PR tiene como objetivo..."). Sin emojis a menos que el repositorio los use.
- Capturas de pantalla o ejemplos de salida: indica dónde ayudarían; nunca describas una captura que no hayas visto.
- Muestra el título y el cuerpo en un bloque de código para que se puedan copiar. No ejecutes
gh pr createa menos que te lo pidan.