GitHub Projects: gestión básica de tareas y estructura del código

Clase 5 de 22 • Curso de Introducción a DevOps

Resumen

Trabajar en proyectos utilizando metodologías DevOps requiere mantener una estructura clara y organizada en la gestión de tareas. Pequeños detalles, como ignorar la creación y seguimiento de issues en plataformas como GitHub, pueden generar malos hábitos perjudiciales para tu proyecto. Aquí aprenderás a mantener un orden óptimo siguiendo buenas prácticas al gestionar tus tareas en GitHub mediante issues y tableros de control (boards).

¿Por qué es fundamental crear y gestionar tareas en GitHub?

La creación sistemática de tareas e issues dentro de GitHub permite que tu trabajo sea más claro y estructurado. Al registrar cada tarea:

Evitas perder detalles importantes.
Facilitas la gestión visual de actividades pendientes, en proceso o terminadas.
Promueves el enfoque en tareas específicas, brindando claridad y orden al flujo de trabajo.

Es importante asignarte las tareas y establecer iteraciones, lo que incrementa la visibilidad sobre el alcance y tiempo esperado de finalización.

¿Cómo mantener una estructura ordenada en tu proyecto?

El orden es básico en cualquier proyecto de programación. Se recomienda:

Crear una carpeta específica src (source) para almacenar tu código fuente.
Dentro de esta carpeta colocar tu proyecto generado, por ejemplo con el comando:

dotnet new webapi -n contactosAPI

Contar con un archivo .gitignore personalizado y eficiente, ignorando carpetas como:
BIN
OBJ

De esta manera, solo subirás al repositorio archivos esenciales, manteniendo el control y orden del proyecto.

¿Cómo actualizar y gestionar tareas eficientemente en GitHub?

El proceso básico para avanzar tareas consiste en:

Mover cada tarea del estado "Ready" a "In Progress" cuando comienzas a trabajar en ella.
Cometer los cambios realizados claramente en tu control de versiones (ej., Git).
Finalmente, mover manualmente las tareas completadas al estado "Done".

Sin embargo, aunque esta forma básica funciona, permite espacio para mejoras importantes que te permitirán gestionar aún más eficientemente el seguimiento, cierre y actualización automática de tareas que verás próximamente.

Diana Flores

student•

Como Jira

edward.arroyave

student•

Sí, en Jira es posible gestionar proyectos con este estilo, pero considero que la metodología más acertada en este caso sería Kanban, ya que asi se gestiona el proyecto en esta metodologia

Diego Mauricio Zuluaga Rodríguez

student•

Cerrar un issue automáticamente en GitHub es un proceso sencillo. Puedes hacerlo vinculando un commit al issue mediante un mensaje que contenga "closes #número_del_issue". Aquí te explico cómo hacerlo:

Crear un issue: Supón que tienes un issue con el número #6.
Modificar tu código: Realiza los cambios necesarios en tu proyecto.
Hacer un commit: Al momento de hacer un commit, usa un mensaje que contenga "closes #6". Por ejemplo:
```
git commit -m "Implementa la funcionalidad X y closes #6"
```
Subir los cambios: Luego, realiza un push:
```
git push origin main
```

Al hacer esto, GitHub cerrará automáticamente el issue #6 al integrar tus cambios. Es una práctica útil para mantener la gestión de tareas organizada dentro de un proyecto.

José Luis Quiróz Casas

student•

Maravilloso curso, gracias

Diego Mauricio Zuluaga Rodríguez

student•

Para cerrar un issue en GitHub, sigue estos pasos:

Accede a tu repositorio: Inicia sesión en GitHub y navega hasta el repositorio donde está el issue.
Ve a la sección de "Issues": Haz clic en la pestaña "Issues" en la parte superior del repositorio.
Selecciona el issue: Busca el issue que deseas cerrar y haz clic en su título.
Cierra el issue: En la parte inferior de la página del issue, haz clic en el botón "Close issue".

Recuerda que puedes cerrar un issue automáticamente vinculando un commit a él mediante un mensaje que contenga "closes #número_del_issue".

Diego Mauricio Zuluaga Rodríguez

student•

Para revertir a estados anteriores en tu código utilizando Git, sigue estos pasos:

Verifica tu historial de commits: Ejecuta git log en tu terminal. Esto mostrará una lista de commits anteriores con sus hashes.
Selecciona el commit al que deseas volver: Identifica el hash del commit deseado, que aparece al inicio de cada línea.
Revertir el último commit: Si simplemente deseas deshacer el último commit, utiliza:
```
git revert HEAD
```
Esto creará un nuevo commit que deshace los cambios del último commit.
Revertir a un commit específico: Para volver a un commit específico y perder los cambios posteriores, usa:
```
git reset --hard <commit_hash>
```
Advertencia: Esto eliminará todos los cambios posteriores, así que asegúrate de que no necesitas esos cambios.
Confirma los cambios: Usa git log nuevamente para verificar el nuevo estado de tu historial.

Ejemplo práctico:

Si deseas volver al commit con hash abc123, ejecutarías git reset --hard abc123.

Recuerda que es importante trabajar con cuidado al hacer resets, ya que puedes perder cambios no guardados.

Diego Mauricio Zuluaga Rodríguez

student•

Para realizar un commit en Visual Studio Code (VS Code), sigue estos pasos:

Abre VS Code y navega a tu proyecto.
Asegúrate de que Git está instalado y tu repositorio está inicializado (git init).
En la parte lateral izquierda, haz clic en el icono de Control de Código Fuente (Source Control).
Realiza cambios en tus archivos. Verás los cambios listados en la pestaña de Control de Código Fuente.
Haz clic en el campo de texto donde dice "Mensaje de commit" y escribe un mensaje descriptivo sobre lo que cambiaste.
Haz clic en el icono de check (✔) para realizar el commit.

El commit se utiliza para guardar los cambios en tu repositorio local, permitiendo llevar un historial de modificaciones y revertir a estados anteriores si es necesario.

Diego Mauricio Zuluaga Rodríguez

student•

El archivo .gitignore se utiliza para especificar qué archivos o directorios no deben ser seguidos por Git. Esto es útil para evitar que se suban archivos temporales, de configuración o de compilación, que no son relevantes para el proyecto.

Para crear un .gitignore, simplemente debes crear un archivo con ese nombre en la raíz de tu repositorio. Puedes agregar patrones para archivos o directorios que deseas ignorar, por ejemplo:

# Ignorar archivos de compilación
/bin/
/obj/

# Ignorar archivos de configuración
*.config

Al usar Git, cualquier archivo que coincida con las reglas en .gitignore será ignorado durante los commits y no aparecerá en el repositorio. Esto permite mantener el repositorio limpio y enfocado en los archivos que son importantes para el desarrollo.

Diego Mauricio Zuluaga Rodríguez

student•

Para guardar tu proyecto en Git, sigue estos pasos detallados:

Abre la terminal y navega a tu directorio de proyecto.
Inicializa el repositorio:
```
git init
```
Agrega los archivos al área de preparación (staging area):
```
git add .
```
Esto agrega todos los archivos. Puedes especificar archivos individuales si lo prefieres.

Realiza el commit con un mensaje:

git commit -m "Mensaje descriptivo de tu cambio"

Conecta tu repositorio local con uno remoto (por ejemplo, en GitHub):
```
git remote add origin URL_de_tu_repositorio
```
Envía tus cambios al repositorio remoto:
```
git push -u origin master
```

Repite el proceso de agregar, commitear y hacer push cada vez que realices cambios.

Diego Mauricio Zuluaga Rodríguez

student•

En GitHub Projects, cada módulo se organiza en columnas que representan diferentes etapas del flujo de trabajo, como "To Do", "In Progress" y "Done". Al pasar una tarea a "In Progress", indicas que estás trabajando activamente en ella. Esto facilita el seguimiento del progreso y permite que los miembros del equipo vean en qué estás enfocado.

Es crucial mantener esta organización para evitar malos hábitos y asegurar que el proyecto avance adecuadamente, siguiendo la metodología DevOps.