Contribuir a Open Source en GitHub

La página principal donde aparecen todos estos proyectos Open Source es en GitHub, para ello, es necesario tener una cuenta.

El siguiente paso es encontrar un proyecto al que queramos contribuir. Dentro de la pestaña Explore podrás encontrar diferentes repositorios basados en tus intereses, populares, por categorías, etc.

Issues

Dentro de un repositorio, tenemos varias pestañas disponibles. Aparte de la pestaña del código (code), existen otras como Issues, Pull requests, Actions… La pestaña Issues se usa para reportar bugs o pedir nuevas funcionalidades, por lo que siempre es buena idea pasarse por ahí para intentar solucionar algún problema. También puedes buscar Issues en todo GitHub directamente.

Estos Issues tienen diferentes etiquetas indicando el tipo de problema. Al estar empezando, puede que sea buena idea buscar por good first issue, ya que suelen ser problemas más sencillos. Pero si estamos empezando, puede que sea mejor arreglar algo de la documentación para coger la mecánica.

Pull requests

La pestaña de Pull requests contiene posibles soluciones a estos Issues que algunos contribuyentes han propuesto. Para que esta solución se acepte, uno de los dueños del repositorio deberá revisar tus cambios comprobando que todo sea correcto antes de juntarlo con el proyecto.

Cómo contribuir

Las acciones disponibles en un repositorio es observar (watch, se te notificará de los recientes cambios del repositorio), indicar que te gusta (start) y hacer un Fork, que sería editar tu propia versión del proyecto. Esto último es exactamente lo que queremos.

Antes de meterse de lleno a editar cosas, es importante entender bien el proyecto: en el archivo README.md podrás encontrar más información sobre el mismo. Además de este archivo, algunos incluyen una guía de contribución o código de conducta (CONTRIBUTING.md/CODE_OF_CONDUCT.md).

Al hacer click en este botón de Fork, se creará una copia del proyecto en tu propia cuenta, por lo que lo podrás editar con total libertad, pero deberías crear tu propia rama para no modificar el proyecto directamente y afectar el trabajo de otros, además de que puede que haya nuevos cambios y acabes añadiendo código desactualizado.

El siguiente esquema muestra los pasos a seguir para enviar los cambios al proyecto.

# Obtener copia local
git clone <fork_del_proyecto>

# Crear rama
git branch <tu_rama>
git checkout <tu_rama>

# Añadir el repositorio original
git remote add upstream <link_del_projecto>

# Cambios en los archivos
git diff # Muestra los cambios
git add .
git commit -m "<descripción>"

# Comprobar si hay actualizaciones
git pull upstream <rama_principal>
git pull upstream <tu_rama>

# Enviar los cambios al fork
git push origin <tu_rama>

# Si el último comando te dio problemas, prueba con a especificar el upstream
git branch --set-upstream-to=origin/<rama_principal> <tu_rama>

Ahora en GitHub debería aparecer una notificación de Pull request, pulsa en el botón de Comparar & Pull Request y añade una descripción según aparezca en la guía de contribución. Una vez cubierto y enviado, esta debería junto a otras del repositorio original. Ahí puedes esperar a que acepten tus cambios o bien te pueden proponer sugerencias, etc. En ese caso, deberías hacer otra rama nueva.

¡Listo! Acabas de hacer tu primera contribución a Open Source.