Como Contribuir a un Proyecto Open Source en GitHub (Guía Práctica)

En este artículo aprenderás paso a paso cómo realizar tus primeras contribuciones a proyectos de código abierto en GitHub, desde la creación de un fork hasta el envío de un pull request.

pagina web de contribuyentes web

¿Qué es un Proyecto Open Source?

Un proyecto Open Source o de código abierto es un proyecto generalmente creado por la comunidad de desarrolladores y que es de libre acceso para que cualquier persona pueda colaborar en él.

¿Por qué contribuir a un Proyecto Open Source?

Contribuir a un proyecto de código abierto te permite:

Aprender nuevas tecnologías y prácticas de desarrollo.
Colaborar con otros desarrolladores y construir una red profesional.
Mejorar tus habilidades de programación y resolución de problemas.
Contribuir al bien común y ayudar a la comunidad de desarrolladores.
Destacar tu trabajo y construir un portafolio sólido.

Requisitos Básicos para Contribuir

Antes de empezar, asegúrate de cumplir con los siguientes requisitos:

Cuenta de GitHub: Crea una cuenta gratuita en GitHub.
Conocimientos de Git: Aprende los comandos básicos, como clone, add, commit, y push.
Editor de código: Utiliza un editor como Visual Studio Code.
Conocimientos básicos de programación: Familiarízate con el lenguaje del proyecto que deseas contribuir.
Paciencia y ganas de aprender: La colaboración requiere tiempo y disposición para recibir retroalimentación.

En este artículo te guiaré con un ejemplo práctico de cómo contribuir a un proyecto de código abierto en GitHub

Para este ejemplo, usaremos un repositorio de GitHub que he creado específicamente para que puedas practicar tus contribuciones de manera segura y efectiva.

Proyecto de Contribuyentes de GitHub

Paso 1: Hacer un Fork del Repositorio

¿Qué es un fork?

Un fork es una copia de un repositorio en tu cuenta de GitHub. Esto te permite:

Trabajar en el proyecto sin afectar el repositorio original.
Hacer cambios en tu fork y luego enviarlos de vuelta al repositorio original mediante un pull request.

Para crear un fork:

Ve al repositorio original Proyecto de Contribuyentes de GitHub.
Haz clic en el botón Fork ubicado en la parte superior derecha de la página.

Create Fork

Paso 2: Clonar tu Fork a tu Máquina Local

Una vez creado el fork, es momento de clonarlo en tu computadora para empezar a trabajar.

Abre tu terminal o el terminal integrado de tu editor de código (por ejemplo, Visual Studio Code).
Usa el comando git clone seguido de la URL de tu fork. Por ejemplo:

git clone https://github.com/tu-usuario/opensource.git

Clonar Repositorio

Cambia al directorio del proyecto clonado:

cd opensource

Configura el repositorio original como remoto adicional para mantener tu fork actualizado. Usa el siguiente comando:

git remote add upstream https://github.com/Porx312/opensource.git

Esto asegura que puedas obtener los últimos cambios del repositorio original ejecutando:

git fetch upstream

Paso 3: Crear una Rama para tu Contribución

Antes de realizar cambios, crea una nueva rama para organizar tu trabajo:

git checkout -b mi-contribucion

Esto facilita el proceso de enviar tus cambios sin alterar la rama principal de tu fork.

Edita el Archivo `src/contributors.ts`

Como primer ejercicio práctico, te guiaré para hacer tu primer cambio en el proyecto. Agregarás tu nombre y tu usuario de GitHub al archivo src/contributors.ts.

Pasos:

Ubica el archivo en tu editor de código
Ve a la carpeta src dentro del proyecto y abre el archivo contributors.ts.
Agrega tu información
Dentro del archivo encontrarás una lista con objetos en formato TypeScript. Cada objeto representa un contribuyente. Para añadirte, simplemente agrega una nueva entrada con tu nombre y usuario de GitHub. Por ejemplo:
```
const contributors = [
    { name: 'Juan Pérez', github: 'juanperez' },
    { name: 'codeporx', github: 'codeporx' },
   // <- Agrega tu contribución aquí
```

Paso 4: Hacer Cambios y Confirmarlos

Realiza los cambios necesarios en el proyecto utilizando tu editor de código.
Guarda los archivos modificados.
Agrega los archivos al área de preparación (staging area):

git add .

Crea un commit describiendo brevemente los cambios realizados:

git commit -m "Descripción de los cambios"

Paso 5: Enviar Cambios a tu Fork

Sube los cambios a tu fork en GitHub:

git push origin mi-contribucion

Paso 6: Crear un Pull Request

Ve a tu fork en GitHub.
Haz clic en el botón Compare & pull request que aparece después de hacer un push.
Escribe una descripción detallada de los cambios realizados.
Envía el pull request para que el mantenedor del proyecto lo revise.

Paso 7: Resolver Comentarios y Feedback

Es posible que el mantenedor del proyecto sugiera cambios. Si es así:

Realiza los cambios sugeridos en tu rama local.
Confirma y sube los cambios nuevamente: 3.espera a que el mantenedor del proyecto apruebe tus cambios.

git add .
git commit -m "Incorporar sugerencias"
git push origin mi-contribucion

Los cambios se reflejarán automáticamente en el pull request.

Paso 8: Mantener tu Fork Actualizado

Para evitar conflictos, mantén tu fork sincronizado con el repositorio original:

git fetch upstream
git merge upstream/main

Esto asegura que trabajas con la versión más reciente del código.

Conclusión

Contribuir a proyectos Open Source en GitHub es una excelente manera de aprender, colaborar y crecer como desarrollador. Sigue estos pasos prácticos y estarás listo para realizar tus primeras contribuciones. ¡Empieza hoy mismo!