Trabajo Colaborativo en GitHub🐱 🐙

Aquí te presentaremos una versión resumida de la guía rápida para comenzar a utilizar GitHub. La versión oficial la puedes encontrar en https://guides.github.com/activities/hello-world/

GitHub es una plataforma de desarrollo colaborativo para alojar proyectos utilizando el sistema de control de versiones Git. Allí podrás almacenar, administrar tus códigos y llevar registro y control de los cambios que se han hecho a través del tiempo.

En este mini-tutorial aprenderás los pasos básicos de como crear un repositorio, crear una rama de trabajo (branch) , registrar un cambio de código (commit + push) y solicitar al dueño del repositorio que se incluyan los cambios que hiciste en la versión oficial del código (pull request).

Paso 1: Crea una cuenta de GitHub en https://github.com/

Paso 2 : Crear un repositorio en GitHub

Un repositorio va a ser el lugar donde almacenarás todo lo que tu proyecto necesite, desde imágenes, videos, datasets y archivos de código.

Luego de haber iniciado sesión debes dar click en el símbolo + en la parte superior derecha de la página de GitHub y luego seleccionar la opción New repository para crear un nuevo repositorio.

Para crear el repositorio debes asignarle un nombre, una descripción y es recomendado que inicies tu repositorio con un archivo README. En este archivo se usa para incluir información relevante de tu proyecto y de los códigos o archivos que tengas almacenados.

Si quieres tener el repositorio en tu computador local puedes clonarlo desde la página de GitHub. Para esto tendrás que:

1. Descargar e Instalar Git en tu computador

2. Abrir la consola de comandos de tu computador

3. A través de la consola dirígete a la carpeta donde quieres almacenar tu repositorio, para esto puedes usar el comando cd folder_path (reemplaza folder_path por la ruta donde quieres almacenar el repositorio) y presiona enter.

4. En la página de GitHub da click sobre el botón verde llamado code y copia la URL que aparece en la opción HTTPS .

5. En la consola escribe git clone seguido de la URL que acabas de copiar

6. Luego el repositorio empezará a descargar y aparecerá como una carpeta en el path que definiste anteriormente.

Paso 3: Crear una rama

Crear ramas es una forma de trabajar diferentes versiones del repositorio al mismo tiempo.

Usualmente los repositorios cuentan con una rama llamada main o master, esta rama se considera que es la versión oficial del repositorio. Las ramas se crean para realizar modificaciones sobre la rama mainantes de registrar un cambio del código con un commit.

Cuando se crea una rama a partir de la rama main, significa que se hace una copia de los archivos de la rama main en ese momento del tiempo. Sin embargo, si alguien hace un cambio en la rama main mientras tú trabajas en la rama de edición puedes actualizar los cambios realizando una acción llamada pull.

En el diagrama podemos ver una rama principal que se llama master, una rama de edición que se llama feature la cual registra cambios de código llamados commit, una etapa de pull request que es la forma de solicitar al dueño del repositorio que incluya nuestros cambios en la versión oficial del repositorio, es decir, la rama main o master en este caso.

Para crear una rama desde la interfaz de GitHub:

1. Entra al repositorio que creaste

2. Da click en la lista desplegable que dice main y escribe el nombre de la nueva rama. Luego, das click en donde dice create branch

Para crear una rama desde la consola de comandos: * Nota: La terminal debe estar dentro de la carpeta del repositorio que clonaste de GitHub. 1. Ejecuta el comando

 git checkout -b < nombre nueva rama >

En el anterior ejemplo la nueva rama se llama session1_eda

Paso 4: Hacer y registrar cambios con el comando commit

En git cuando quieres registrar un cambio se usa el comando commit, estos cambios van asociados a un mensaje del commit (commit message) que es una descripción que debe explicar cuales fueron los cambios que se hicieron y por qué se hicieron. Estos mensajes registran la historia de todos los cambios que ha tenido el repositorio para que otros contribuidores puedan entender cuando y por qué se han realizado esos cambios.

Para hacer cambios en los archivos directamente en la interfaz de GitHub:

Suponiendo que vamos a editar el archivo README...

1. Damos click en el icono de lápiz que hay en la parte superior derecha del archivo README.md para editar el archivo.

Debemos asegurarnos que los cambios que vamos a realizar sean sobre una rama de edición, en este caso se llama session1_eda. NO es una buena práctica realizar cambios directamente en la rama main.

2. En el editor, escribimos una descripción breve del proyecto.

3. En la parte inferior debes incluir un mensaje corto del commit y si lo deseas uno más detallado de los cambios realizados. Para finalizar das click en el botón commit changes.

Para hacer cambios en los archivos en la consola de comandos:

1. En la carpeta del repositorio se pueden agregar o modificar archivos. En este caso se agregará el archivo eda_notebook.ipnyb

Si tienes dudas de los archivos que han cambiado y éste no se ha registrado en el repositorio puedes usar el comando git status

En la imagen podemos ver que Git nos está diciendo que el archivo eda_notebook.ipynb no tiene trazabilidad, es decir, que es un archivo nuevo en el repositorio.

2 . Para agregar el archivo en la rama debemos ejecutar el comando git add <nombre archivo> , seguido del comando git commit -m "<mensaje>" que registrará el cambio y el mensaje descriptivo de los cambios realizados y finalmente enviaremos esos cambios de nuestro computador local al servidor de git mediante el comando git push origin <nombre rama>

git add eda_notebook.ipynb
git commit -m "agrega primera versión del notebook de exploratory data analysis"
git push origin session1_eda

Un ejemplo de como se ve esto ejecutado en la consola:

Paso 5: Crear un Pull Request

Un pull request es la forma de proponer que los cambios que has hecho se incluyan oficialmente en la versión definitiva del repositorio que sería la rama main. Cuando haces un pull request, allí se muestran las diferencias de cosas que se agregaron (resaltadas en verde) o se quitaron (resaltadas en rojo) en cada uno de los archivos del repositorio. Al momento de hacer un commit, es posible hacer un pull request. También puedes agregar a varios colaboradores para que revisen los cambios realizados, puedan comentar, aprobar, solicitar cambios y finalmente hacer merge de la rama de edición a la rama main. Hacer merge implica que los cambios realizados se incluyen en la rama main.

Para realizar un pull request debes:

1. Dar click en la pestaña que se llama pull request

2. Dar click en el botón verde que dice New pull request

3. Para hacer pull request debes comparar la rama main con la rama que tiene los cambios realizados. En este caso, se llama project_description

En este mini-tutorial podemos ver como son los pasos básicos para realizar y registrar cambios en un repositorio. Dado que los cambios quedan registrados es posible volver a una versión anterior de los archivos, así como revisar y certificar los cambios que hace cada uno de los contribuidores del repo.

¡Durante los workshops te invitamos a que tengas tu propio repositorio en GitHub para que puedas ir almacenando todo el contenido que vamos a desarrollar durante las 3 próximas sesiones! Esperamos que lo disfrutes y que sea de mucha utilidad 💙