EST-BDT-006 Estándar para nombres de ramas
v 3.2
Propósito
El propósito de este documento es establecer un estándar para la creación de nombres de ramas 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 nombres de las ramas proporcionan un sistema claro y eficiente para la identificación y el seguimiento de los cambios realizados en los repositorios de 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
Estructura de los nombres de las ramas
Los nombres de las ramas deben seguir la siguiente estructura:
Prefijos de ramas:
- feat: Nueva funcionalidad
- fix: Corrección de errores
- docs: Cambios en la documentación
- style: Cambios que no afectan el significado del código (espacios en blanco, formato, punto y coma que faltan, etc.)
- refactor: Cambios en el código que no corrigen errores ni agregan funcionalidades
- test: Agregar pruebas faltantes o corregir pruebas existentes
- chore: Cambios en el proceso de construcción o herramientas auxiliares y bibliotecas como generación de documentación, etc.
<prefijo>/<num_requerimiento>-<nombre-de-la-funcionalidad>
El nombre de la funcionalidad, debe de escribirse en minúsculas y separado por guiones. La funcionalidad debe de ser una descripción clara y concisa de la funcionalidad que se está desarrollando. Se recomienda no dessarrollar funcionalidades muy grandes en una sola rama.
Ejemplos de nombres de ramas
feat/RF01-login
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 | Daniel Hurtado | 11/03/2024 |
| v.2.0 | Se agregaron ejemplos de nombres de ramas | N/A | Daniel Hurtado | Sergio Garnica | 08/04/2024 |
| v 3.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 | 24/04/2024 |
| v 3.1 | Corregir ortografía | Se modificó una palabra mal escrita | Mafer Moreno | Ricardo Rosales | 25/04/2024 |
| v 3.2 | Versionamiento y ortografía | Se acutalizó la inconsistencia en el versionamiento y errores ortográficos | Sergio Garnica | 29/04/2024 |