ES01-Estándar de nombramiento de ramas
Las ramas en GitHub deberán ser nombradas con el siguiente formato, con el fin de estandarizar y facilitar la identificación de la finalidad de la misma. Los nombres de las ramas deben ser escritos en inglés, sin acentos, espacios ni caracteres especiales con cada sección del nombre en CammelCase, separados por una diagonal.
<type>/<scope>/<featureName>
NO SE PONEN LOS SÍMBOLOS DE MAYOR Y MENOR QUE.
Type
type es el tipo de cambio que se está haciendo (de acuerdo a los estándares de Conventional Commits v1.0.0) y puede ser uno de los siguientes valores (ordenados por su frecuencia de uso):
- feat -> cualquier contenido nuevo que va a ser agregado.
- fix -> correcciones a contenido ya en repo (bugfixes).
- test -> agrega o corrige pruebas.
- style -> cambios que no afectan el significado del código ni su performance (espacios en blanco y formateo).
- revert -> eliminar el commit anterior.
- refactor -> cambio que no arregla un bug ni agrega un feature (reestructuración de código).
- docs -> documentación de código.
Estos son equivalentes a los tipos de commits.
Scope
scope es el grupo de casos al que pertenece la funcionalidad a implementar/editar.
Por ejemplo, diferentes tipos de scope para la Wiki son:
- Política
- Guía
- Proceso
- Plantilla
- Definición
El scope para código sería la User Story a la que pertenece.
Feature name
featureName es el nombre descriptivo de la característica o funcionalidad que se está implementando o editando.
Ejemplos
| Nombre de la rama | Caso de ejemplo |
|---|---|
feat/procesos/procedimiento junta | Agregar Procedimiento a un proceso de junta |
fix/procesos/errores ortograficos | Corregir errores de ortografía o tipografía en el proceso de juntas |
refactor/procesos/procedimiento junta | Refactorizar el procedimiento del proceso de juntas |
style/procesos/procedimiento junta | Ajustar el estilo o ejecutar un software de formato en el procedimiento del proceso de juntas |
*Las ramas en este ejemplo son en español por consistencia con el documento y el repositorio actual.
Referencias
Commit Lint Conventional types Conventional Commits v1.0.0
Autores
Versiones
| Versión | Descripción | Responsables | Fecha |
|---|---|---|---|
| 1.0 | Creación de la Política | Bernardo Estrada | 17/03/2022 |
| 1.1 | Corrección Ortografía | Bernardo Estrada | 23/03/2022 |
| 1.2 | Aumentar nivel de detalle | BE & MN | 04/04/2022 |
| 1.3 | Corrección ortográfica | Guillermo C. Espino | 04/04/2022 |
| 1.4 | Cambio a estándar | Alberto Matute | 03/05/2022 |
| 1.5 | Cambio de estilo de links | Alberto Matute | 07/06/2022 |