Comencemos
Este documento establece las directrices para el desarrollo en nuestra empresa. Siguiendo estas guías, garantizamos consistencia, calidad y eficiencia en todos nuestros proyectos.
Guías para el desarrollo
Flujo de trabajo para desarrollo
Creación de una nueva branch
Cada tarea asignada debe estar asociada a un issue. Al tomar un issue, crea una nueva branch siguiendo esta convención:feat/<numero-issue>-<descripcion-corta>Ejemplos:
- Si el issue es el #22 y la tarea es agregar un catálogo, el nombre de la branch sería:
feat/22-add-catalog. - Para el issue #45, donde la tarea es corregir un error en el login, usarías:
fix/45-login-bug. - Si el issue es #101, relacionado a mejorar la interfaz de búsqueda, usarías:
feat/101-update-search-ui.
- Si el issue es el #22 y la tarea es agregar un catálogo, el nombre de la branch sería:
Implementación y finalización del feature
Una vez completado el desarrollo del feature:- Abre un Pull Request (PR) que apunte a la rama
main. - Asegúrate de enlazar el issue correspondiente en el PR. Esto se puede hacer mencionando el número de issue en el cuerpo del PR usando:
Closes #<numero-issue>.
- Abre un Pull Request (PR) que apunte a la rama
Revisión de código (Code Review, CR)
- Solicita una revisión de código.
- El feature solo se considerará terminado una vez que la revisión sea aprobada.
Cierre del feature e issue
- Luego de aprobarse el PR, mergea los cambios en
main. - Cierra el issue asociado al PR.
- Luego de aprobarse el PR, mergea los cambios en
Notas adicionales
- Asegúrate de que los nombres de las ramas sean descriptivos y reflejen claramente la tarea asignada.
- Sigue las guías de estilo y formatos establecidos en este documento para garantizar claridad y facilidad de colaboración.
