EST-DGT-008 Envío de Pull Requests DotGeist
v 4.0
Propósito
El propósito de este documento es establecer un estándar para la creación de Pull Requests en los repositorios de código de Black Dot, con el fin de garantizar la consistencia, la accesibilidad y la trazabilidad de los cambios realizados en el código de la organización.
Notas introductorias
Los Pull Requests proporcionan un sistema claro y eficiente para la revisión y aprobación de cambios en el código de la organización, facilitando la gestión y el acceso a la información en los repositorios de Black Dot.
Estándares
Creación de Pull Requests
-
Creación de Branches: Antes de realizar cambios en el código, se debe crear un branch con un nombre descriptivo que refleje el propósito de los cambios a realizar. El branch debe ser creado a partir de la rama
develop
del repositorio. -
Commits: Los cambios realizados en el código deben ser agrupados en commits que reflejen de manera clara y concisa el propósito de los cambios realizados. Los commits deben ser realizados en el branch creado para los cambios.
-
Pull Request: Una vez que los cambios han sido realizados y los commits han sido realizados, se debe crear un Pull Request para solicitar la revisión y aprobación de los cambios realizados. El Pull Request debe ser creado a partir del branch en el que se realizaron los cambios.
-
Descripción del Pull Request: El Pull Request debe incluir una descripción clara y concisa de los cambios realizados, así como una lista de los cambios realizados y los problemas resueltos. La descripción del Pull Request debe ser lo suficientemente clara para que cualquier miembro del equipo pueda entender los cambios realizados.
-
Revisión del Pull Request: Una vez que el Pull Request ha sido creado, se debe solicitar la revisión del Pull Request a un miembro del equipo. El miembro del equipo encargado de la revisión debe ser seleccionado de acuerdo a la naturaleza de los cambios realizados.
Contenido del Pull Request
El Pull Request de backend debe seguir el siguiente:
Control de cambios
Versión | Cambio realizado | Análisis | Autor | Revisor(es) | Fecha de cambio |
---|---|---|---|---|---|
v 1.0 | Creación del estándar | N/A | Carlos Salguero | Sergio Garnica | 11/03/2024 |
v 2.0 | Ajuste de formato | Se modificó el contenido del estándar de acuerdo a la plantilla porque el documento tenía información no requeridas | Yuna Chung | Ricardo Fernández | 23/04/2024 |
v 3.0 | Migración de estándar | Se migró a un estándar del equipo DotGeist para adaptarlo a sus prácticas | Arturo Díaz | Ian Padrón | 03/05/2024 |
v 3.1 | Corrección de link | El nombre de un archivo se cambió, por lo tanto también se cambió el link | Carlos Velasco | Sergio Garnica | 16/05/2024 |
v 4.0 | Contenido de Pull Request | Acctualizar plantilla para PR del backend y agregar la del frontend | Sergio Garnica | 17/05/2024 |