Guía para hacer pull requests
Objetivo
Explicar a los integrantes del departamento cómo hacer solicitudes de cambio para los elementos de configuración, con el propósito de prevenir defectos, mejorar la calidad de los productos de trabajo, lograr trazabilidad entre los cambios y permitir la gestión de versiones.
Nota:
Los cambios a realizar no forzosamente tienen que ser código.
Prerrequisitos para hacer una solicitud de cambios
- Asegúrese de que el trabajo a integrar sea una tarea completa.
- Asegúrese de que los cambios cumplan con las checklists de calidad que les corresponda.
- Asegúrese de que el trabajo a subir al nivel controlado sea un elemento de configuración con los siguientes criterios.
Realización de una solicitud de cambio
- Añada los cambios
- Vea los cambios que están en la versión que está editando. Al usar git, emplee el comando “git status” para ver las modificaciones en su rama.
- Obtener otros cambios realizados en el elemento de configuración. En git, obtenga las modificaciones nuevas usando el comando “git pull”.
- Revise los cambios a realizar.
- Añada las modificaciones necesarias a la solicitud de cambio. Si está usando git y desea incluir todas las modificaciones dentro de su solicitud, ejecute el comando “git add -A”. Si hay cambios que no quiera integrar, haga “git add <path>” por cada uno de las modificaciones a incluir en su solicitud.
- Elimine cambios que no sean necesarios. En git, después de incluir las modificaciones ejecute el comando “git stash” para eliminar los cambios innecesarios de su rama.
- Guarde los cambios en el sistema de manejo de configuración
- En su solicitud, añada un mensaje que explique los cambios realizados. Si está usando git y las modificaciones son expresables en una sola línea, use el comando “git commit -m <mensaje>”. Si hizo una gran cantidad de cambios que no son enunciables en una sola línea, haga un listado de las modificaciones con el comando “git commit”(sin el “-m”) para abrir un editor de texto.
- Dentro del editor, utilice la primera línea para escribir el asunto del cambio. El asunto debe contener un verbo en infinitivo y un resumen de las modificaciones.
- Escriba a continuación cada uno de los cambios en bullet points de manera más específica.
- Publique los cambios al sistema de manejo de configuración. Si está usando git, ejecute el comando “git push origin <su_rama>”.
- Obtenga la última versión del nivel controlado del sistema de configuración. Si está usando git, ejecute el comando “git pull origin <rama a la que desee integrar>”. Realice luego lo siguiente:
- Si hay conflictos, resuélvalos.
- Añada los cambios realizados. Si está en git, ejecute el comando “git add -A”.
- Añada un mensaje que explique los cambios. En git, ejecute el comando “ git commit -m ‘arregle conflictos’ ”.
- Publique los cambios en el sistema de manejo de configuración. En git, ejecute el comando “git push origin <su_rama>”.
Haga una solicitud de cambio.
Si está usando git, haga lo siguiente:
- Abra en el navegador el repositorio de github correspondiente.
- Diríjase a la pestaña de “Pull Requests”.
- De clic en el botón “New pull request”.
- Deje la rama a integrar con los cambios como rama base y ponga como rama de comparación la rama que contenga los cambios.
- De clic al botón “Create new pull request”.
- Revise que el nombre del pull request sea el correcto.
- Haga un listado de todos los cambios a aplicar en el cuerpo del pull request.
- De click en el apartado de Reviewers del lado derecho de la página
- Escoja a un reviewer
- Si no sabe a quién escoger, utilice el inventario de habilidades para encontrar a un reviewer adecuado.
- Si integra a master, incluya como reviewers a los integrantes del CCB.
- De clic en el botón “Create pull request”.