Al crear una solicitud de incorporación de cambios, pide a otros usuarios que revisen los cambios y proporcionen comentarios. Las solicitudes de incorporación de cambios centradas, claras y fáciles de seguir ayudan a los revisores a proporcionar mejores comentarios y hacer sugerencias seguras.
Hacer que los cambios sean fáciles de revisar
El contexto claro ayuda a los revisores a comprender rápidamente qué ha cambiado y por qué es importante. Reduce el retroceso, hace que la revisión sea más rápida y ayude a su equipo a centrarse en las partes más importantes del cambio.
Escritura de solicitudes de incorporación de cambios pequeñas
Las solicitudes de extracción pequeñas y bien delimitadas son más fáciles de revisar y más seguras de fusionar. Ayudan a los revisores a comprender el propósito del cambio, detectar problemas más rápidamente y seguir el historial del proyecto más adelante.
Cuando un cambio aumenta de tamaño, considere la posibilidad de dividirlo en solicitudes de incorporación de cambios más pequeñas que cada una tenga un propósito.
Proporción de contexto y guía
Un título claro y una descripción ayudan a los revisores a comprender el problema, el enfoque y el resultado. Un buen contexto suele explicar por qué se necesita el cambio, qué cambió y dónde deben prestar especial atención los revisores.
La guía es especialmente útil cuando una solicitud de incorporación de cambios toca muchos archivos o requiere un orden de revisión específico. Por ejemplo, puede apuntar a los revisores a los archivos más importantes primero o explicar qué tipo de comentarios sería más útil. También puede usar GitHub Copilot para generar un resumen de su pull request.
Primero, revise su propio pull request.
Revisar su propia solicitud de incorporación de cambios antes de pedir a otros usuarios que lo revisen le ayuda a detectar errores temprano. También muestra a los revisores que la solicitud de incorporación de cambios está lista para su atención.
Una autorrevisión puede incluir revisar el diff, comprobar si hay cambios accidentales y asegurarse de que se han ejecutado las compilaciones o pruebas pertinentes.
Revisión de la seguridad
Las revisiones de seguridad ayudan a detectar riesgos antes de fusionar una solicitud de extracción. Esto es especialmente importante cuando una solicitud de incorporación de cambios cambia las dependencias, la autenticación, los permisos, los flujos de trabajo o el código que controla los datos confidenciales.
GitHub puede mostrar información de seguridad en las solicitudes de extracción, como cambios en las dependencias, resultados de la revisión de dependencias y las comprobaciones de code scanning. Use estas señales para resolver problemas pronto o para resaltar los riesgos que necesitan atención de los revisores.
Si tu repositorio tiene code scanning configurado como verificación, Corrección automática de GitHub Copilot puede sugerir correcciones para las vulnerabilidades de seguridad.
Mantener informado al equipo
Las solicitudes de incorporación de cambios pueden hacer más que los cambios en el código de documento; también son una manera de mantener al equipo informado sobre el estado del trabajo. El progreso visible ayuda a reducir las actualizaciones de estado independientes y mantiene a todos alineados.
Usa GitHub Copilot para generar resúmenes de solicitudes de extracción
Nota:
Copilot funciones requieren un plan Copilot. Consulte Planes para GitHub Copilot.
Copilot puede generar un resumen de la solicitud de incorporación de cambios en GitHub. Un resumen generado puede ayudar a los revisores a comprender los cambios principales, pero debe revisarlo cuidadosamente y agregar contexto que solo conozca.
Los resúmenes son más útiles cuando explican el propósito del cambio, señalan los archivos importantes y destacan cualquier aspecto que los revisores deban examinar con detenimiento.
Vínculo a problemas o proyectos relacionados
Conectar una pull request con incidencias o proyectos muestra cómo encaja este trabajo en el conjunto del proyecto. Los vínculos ayudan a los revisores a comprender la prioridad, realizar un seguimiento del progreso y buscar discusiones relacionadas.
Usa palabras clave para cerrar incidencias cuando una pull request deba cerrar una incidencia después de fusionarse. También puede vincular a Projects para que las personas puedan realizar un seguimiento del trabajo en un solo lugar.
Resaltar el estado con etiquetas
Las etiquetas de estado ayudan a los revisores a comprender si una solicitud de incorporación de cambios está lista para revisar, bloquear o seguir en curso. Las etiquetas claras facilitan a las personas priorizar las revisiones y evitar revisar el trabajo antes de que esté listo.