Buenas prácticas en Git y GitHub

Curso Básico de Git y GitHub

En este módulo, aprenderemos a implementar prácticas que optimicen la organización y el flujo de trabajo en Git y GitHub, lo cual es fundamental para proyectos colaborativos y de largo plazo.

7.1 Estructuración de commits (mensajes claros y descriptivos)

Un mensaje de commit claro y estructurado es fundamental para que otros colaboradores entiendan el propósito de cada cambio en el proyecto.

Buenas prácticas para mensajes de commit:

• Especificar el cambio: Describe el cambio brevemente, comenzando con un verbo en infinitivo, por ejemplo: Añadir función de validación de formularios.
• Estructura de los mensajes: Incluye una descripción corta en la primera línea (menos de 50 caracteres) y, si es necesario, una explicación más detallada en las siguientes líneas.

Ejemplo:

git commit -m "Añadir función de validación de formularios en la página de registro"

7.2 Trabajo con .gitignore para evitar archivos innecesarios

El archivo .gitignore permite especificar archivos y carpetas que no deben ser incluidos en el control de versiones. Esto es útil para evitar almacenar archivos temporales, datos sensibles, y archivos generados por el sistema o el entorno de desarrollo.

1. Creación de un archivo .gitignore:
   • Crea un archivo llamado .gitignore en la raíz de tu repositorio.
   • Añade patrones para excluir archivos específicos, como carpetas de caché, configuraciones de entorno, y otros.

Ejemplo de .gitignore:

# Ignorar archivos de configuración
.env
config/settings.json

# Ignorar archivos de compilación
/dist
/node_modules

# Archivos temporales
*.log

7.3 Uso de Issues y proyectos en GitHub para seguimiento de tareas

Issues:
Los issues son una excelente herramienta para reportar errores, sugerir nuevas funcionalidades y realizar un seguimiento del progreso.

1. Crear un issue en GitHub:
   • Ve a la pestaña Issues en tu repositorio de GitHub y selecciona New Issue.
   • Escribe un título claro y una descripción detallada del problema o tarea. Puedes asignar etiquetas (tags) y asignar colaboradores para gestionar su resolución.

Proyectos:
La función de proyectos en GitHub permite organizar issues y tareas de un proyecto en tableros Kanban.

2. Crear un proyecto en GitHub:
   • En la sección Projects, selecciona New Project y escoge una plantilla de Kanban o crea una personalizada.
   • Añade tarjetas relacionadas con cada issue para organizar el flujo de trabajo y moverlas según su estado (Pendiente, En Proceso, Completado).

7.4 Mantenimiento y limpieza del historial de Git (squash y rebase)

Mantener un historial de Git ordenado facilita la revisión de cambios en el futuro.

Squash:
Combina múltiples commits en uno solo para reducir la cantidad de cambios en el historial, especialmente útil cuando has realizado varios commits de prueba.

1. Cómo hacer squash de commits recientes:
   • Usa el siguiente comando:
     git rebase -i HEAD~n
   • Reemplaza n con el número de commits recientes que deseas combinar, y selecciona squash para fusionarlos en uno.

Rebase:
El rebase se usa para reorganizar la secuencia de commits y evitar ramas innecesarias.

2. Rebase para limpiar el historial:
   • Ejecuta:
     git rebase main
   • Esto puede ayudar a mantener tu rama actual alineada con main, reorganizando commits y evitando merges innecesarios.