Abrir y describir un PR
Escribiste el cambio, ejecutaste las pruebas, y el diff se ve limpio. Ahora necesitas abrir un PR — pero un título de una línea como "fix bug" no le da al revisor nada de dónde partir. Una buena descripción de PR no repite lo que el diff ya muestra: explica el porqué — qué provocó el cambio, cómo ve
Una buena descripción es como una nota que le dejas a una niñera: escribir 'cuida al niño' no es suficiente — necesitas explicar por qué la rutina de esta noche es distinta y cómo comprobar que todo está bien antes de dormir.
- descripción de PR
- El texto que acompaña a un Pull Request y le explica al revisor por qué se hizo el cambio, cómo probarlo, y cuál es el riesgo — no solo una repetición de lo que el diff ya muestra.
- plantilla de PR
- Un archivo fijo en el repositorio (por ejemplo .github/pull_request_template.md) que determina qué secciones deben aparecer en cada descripción de PR, para que todos completen la misma información.
- PR en borrador (draft)
- Un PR abierto en estado de borrador — visible para el equipo y que ejecuta verificaciones, pero no señala 'listo para revisión completa' hasta que se marca como Ready for review.
- listo para revisión (ready for review)
- La acción que convierte un PR en borrador en un estado que pide activamente la atención completa de un revisor — la señal de que el trabajo está listo, no solo visible.