Skip to content

facusantillo/GitFlow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 

Repository files navigation

GitFlow — Ejemplo de README

Este repositorio contiene plantillas y documentación relacionadas con el flujo de trabajo GitFlow para proyectos dentro de la organización. Está pensado como un punto de partida para equipos que quieren adoptar una estrategia de branching estructurada y reproducible.

Estado

  • Estado: Inicializado (borrador de README)
  • Objetivo: Documentar el modelo GitFlow y proporcionar scripts/plantillas reutilizables para proyectos.

¿Para quién es esto?

Este repositorio es útil para desarrolladores, líderes técnicos y equipos de DevOps que:

  • Necesitan una guía rápida sobre GitFlow.
  • Quieren plantillas que puedan adaptarse a nuevos repositorios.
  • Buscan estandarizar ramas, releases y hotfixes.

Estructura del repositorio

  • README.md — Documentación principal (este archivo).
  • scripts/ — (opcional) utilidades para automatizar tareas de branching y releases.
  • docs/ — (opcional) documentación ampliada y convenciones del equipo.

Nota: En esta inicialización puede que algunos directorios estén vacíos; añada archivos según las necesidades del equipo.

Requisitos

  • Git (>= 2.0)
  • Node.js / Python / herramientas opcionales según los scripts incluidos

Uso rápido

  1. Clonar el repositorio:

    git clone

  2. Revisar la documentación en docs/ y adaptar las plantillas a tu proyecto.

  3. Usar las convenciones descritas abajo para crear ramas y releases.

Resumen del modelo GitFlow (rápido)

GitFlow es una estrategia de branching que ayuda a organizar releases y mantenimiento a largo plazo. A grosso modo:

  • main (o master): rama productiva que contiene código listo para producción.
  • develop: rama donde se integran las nuevas características antes de preparar un release.
  • feature/*: ramas para desarrollar nuevas funcionalidades. Se crean desde develop y se integran de nuevo en develop.
  • release/*: ramas temporales para preparar una versión de producción. Se crean desde develop y, una vez listas, se fusionan en main y develop.
  • hotfix/*: ramas para corregir errores críticos en producción. Se crean desde main y se integran en main y develop.

Flujo típico:

  1. Crear feature: git checkout -b feature/nombre develop
  2. Terminar feature: git checkout develop / git merge --no-ff feature/nombre
  3. Preparar release: git checkout -b release/1.2.0 develop
  4. Publicar release: git checkout main / git merge --no-ff release/1.2.0 / tag y luego fusionar a develop.
  5. Hotfix: git checkout -b hotfix/1.2.1 main → arreglar → merge a main y develop.

Convenciones recomendadas

  • Prefijo de ramas: feature/, bugfix/, release/, hotfix/, chore/.
  • Mensajes de commit claros y con referencia a issues si aplica.
  • Pull requests/MR siempre revisados por al menos otro miembro del equipo.

Cómo contribuir

  1. Haz fork del repositorio o crea una rama en este repo siguiendo las convenciones anteriores.
  2. Crea cambios claros y pruebas cuando corresponda.
  3. Abre un pull request describiendo el cambio, su motivación y los pasos para probarlo.

Licencia

Incluye la licencia del proyecto en el archivo LICENSE en la raíz del repositorio. Asegúrate de revisarla y actualizarla si se requiere otra licencia.


Si quieres, puedo:

  • Añadir una sección de ejemplos concretos de comandos o scripts para automatizar GitFlow.
  • Crear plantillas de PR y de issues para este repositorio.

Indica qué prefieres y lo implemento ahora.

About

GitFlow Example

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published