Categorizar nuestra rama
Todos nuestros repositorios tienen 3 ramas por defecto: develop, release y master.
No debemos hacer ningún commit directo a ninguna de estas 3 ramas, por lo cuál, para todas las tareas que realizamos debemos crear una rama la cuál debe tener como base la rama develop.
Actualmente tenemos 3 tipos para categorizar las tareas que realizamos:
- bugfix. Cuando debemos corregir alguna incidencia que afecta directamente la funcionalidad de cara al usuario.
- feature. Cuando debemos agregar una nueva funcionalidad.
- hotfix. Cuando hay que realizar una corrección urgente en producción
- En la realidad nosotros no usamos esta categoría, debido al proceso de autorización que debe llevar cada despliegue y dado que no hacemos commits directos a las ramas develop, release y master.
Si creamos nuestras ramas desde Jira, no debemos tener problema en poder seguir esta categorización en nuestras ramas.
En caso de que no exista un Jira y/o la rama no sea creada desde Jira.
La nomenclatura debe ser la siguiente
<categoria>/<Jira><resumen de la tarea a realizar> (sin espacios ni caracteres especiales como acentos y ñ)
Ejemplo:
feature/PSA-12345-nueva-funcionalidad
bugfix/PSA-12345-error-en-la-funcionalidad
Info | ||
---|---|---|
| ||
Todas nuestras ramas deben tener un prefijo. No se deben crear ramas sin prefijo |
Otras categorías propuestas.
En un proceso normal de desarrollo estas categorías no deberían ser necesarias, sin embargo, hay ocasiones en las que se realizan estos cambios sin siquiera tener un Jira asociado o problema asociado.
- tests. cuando se agregan tests faltantes sin afectar funcionalidades
- docs. cuando se realizan cambios en la documentación de la aplicación
- style. cuando se realizan cambios en el formateo del código (indentación, espacios en blanco, quitar espacios al final, saltos de línea, etc)