Procedimientos recomendados para crear solicitudes de cambios
Al crear una solicitud de cambios, siga algunos procedimientos recomendados para un proceso de revisión más sencillo. Para más información sobre cómo crear una solicitud de cambios, vea "Crear una solicitud de incorporación de cambios".
Escribir PR pequeños
Intente crear solicitudes de cambios pequeñas y enfocadas que cumplan un único propósito. Las solicitudes de cambios más pequeñas son más fáciles y rápidas de revisar y combinar, dejan menos espacio para introducir errores y proporcionan un historial más claro de los cambios.
Primero, revise su propia solicitud de cambios.
Revise, compile y pruebe su propia solicitud de cambios antes de enviarlo. Esto le permitirá detectar errores o errores tipográficos que puede haber pasado por alto, antes de que otros empiecen a revisar.
Proporción de contexto y guía
Escriba títulos y descripciones claros para las solicitudes de cambios para que los revisores puedan comprender rápidamente lo que hace la solicitud de cambios. En el cuerpo de la solicitud de cambios, incluya:
- el propósito de la solicitud de cambios,
- la información general sobre lo que ha cambiado,
- los vínculos a cualquier contexto adicional, como el seguimiento de problemas o conversaciones anteriores
Para ayudar a los revisores, comparta el tipo de comentarios que necesita. Por ejemplo, ¿necesita una mirada rápida o una crítica más profunda?
Si la solicitud de cambios consta de cambios en varios archivos, proporcione instrucciones a los revisores sobre el orden en el que revisar los archivos. Recomiende por dónde empezar y cómo continuar con la revisión.
Procedimientos recomendados para administrar las solicitudes de cambios
Si es un mantenedor de repositorios, siga estos pasos para administrar y estandarizar las solicitudes de cambios que los colaboradores crean en el repositorio.
Uso de plantillas de PR
Las plantillas de solicitud de cambios le permiten personalizar y estandarizar la información que desea incluir cuando alguien crea una solicitud de cambios en el repositorio. Cuando agregas una plantilla de solicitud de extracción a tu repositorio, los colaboradores del proyecto verán automáticamente los contenidos de la plantilla en el cuerpo de la solicitud de extracción. Para obtener más información, vea «Crear una plantilla de solicitud de extracción para tu repositorio».
Puedes usar plantillas de solicitud de cambios para estandarizar el proceso de revisión del repositorio. Por ejemplo, puede incluir una lista de tareas que desea que los autores completen antes de combinar sus solicitudes de cambios agregando una lista de tareas a la plantilla. Para obtener más información, vea «Acerca de las listas de tareas».
Puede solicitar que los colaboradores incluyan una referencia a un problema en el cuerpo de la solicitud de cambios para que la combinación de la solicitud de cambios cierre automáticamente el problema. Para obtener más información, vea «Vincular una solicitud de cambios a una propuesta».
Definición de propietarios de código
Es posible que quiera asegurarse de que determinados individuos siempre revisen los cambios en determinados archivos o código del repositorio. Por ejemplo, puede que desee que un escritor técnico del equipo revise siempre los cambios en el directorio docs.
Puede definir individuos o equipos que considere responsables del código o los archivos en un repositorio para ser propietarios de código. Cuando alguien abre una solicitud de cambio que modifica el código que pertenece a alguien, automáticamente se les solicitará una revisión a los propietarios del código. Puede definir propietarios de código para tipos específicos de archivos o directorios, así como para diferentes ramas de un repositorio. Para obtener más información, vea «Acerca de los propietarios de código».
Use ramas protegidas
Puede usar ramas protegidas para evitar que las solicitudes de cambios se combinen en ramas importantes, como main, hasta que se cumplan determinadas condiciones. Por ejemplo, puede requerir pasar pruebas de CI o aprobar una revisión. Para obtener más información, vea «Acerca de las ramas protegidas».
Uso de herramientas automatizadas para revisar el estilo de código
Use herramientas automatizadas, como linters, en las solicitudes de cambios del repositorio para mantener un estilo coherente y hacer que el código sea más comprensible. El uso de herramientas automatizadas para detectar problemas más pequeños, como errores tipográficos o de estilos, deja más tiempo para que los revisores se centren en la sustancia de una solicitud de cambios.
Por ejemplo, puede usar GitHub Actions para configurar linters de código que se pueden ejecutar en solicitudes de cambios como parte del flujo de trabajo de integración continua (CI). Para obtener más información, vea «Acerca de la integración continua con Acciones de GitHub».