Skip to content

Contribuir

Agustin edited this page Apr 22, 2021 · 6 revisions
logo

Contribuir en Goto IoT

Te agradecemos mucho que estés interesado en contribuir a los proyectos de Goto IoT.

"Individualmente, somos una gota. Juntos, somos un océano" - Ryunosuke Satoro

En Goto IoT buscamos crear una comunidad abierta que utilice y mejore el material para beneficiarnos entre todos los miembros. También ser un terreno fértil donde se pueda aprender, debatir ideas, proponer cambios y más; sobre todo dando espacio de participar a todas las personas interesadas.

El objetivo de este documento es brindarte una guía con todos los pasos para dar tus primeras contribuciones desarrollando software. Esta guía puede ser válida para cualquier proyecto dentro y fuera de Goto IoT.

Esta guía está inspirada en el repositorio First Contributions donde hay guías para contribuir en decenas de idiomas y para múltiples escenarios.

Enviar tus contribuciones

En esta sección vas a ver todos los pasos que necesitas realizar para enviarnos tus colaboraciones a los proyectos. Si tenés alguna duda podés consultar en la Comunidad de Goto IoT que con gusto vamos a ayudarte.

1. Forkear el repositorio

Cuando sepas dónde querés colaborar, lo siguiente es entrar al repositorio del proyecto de nuestra organizacion y realizar un fork a tu cuenta personal de Github. En la siguiente imagen podés ver el botón a presionar para crear el fork.

fork

2. Clonar el repositorio

Con el repositorio "forkeado", andá a tu cuenta de Github y en el nuevo repositorio que acabás de crear presioná el botón Code y luego copia la dirección al portapapeles. La siguiente imagen te puede ayudar.

fork

Ahora abrí una terminal en el directorio donde quieras descargar el proyecto y ejecutá el comando git clone URL_REPO_RECIEN_COPIADA para tener el código del proyecto en un máquina.

3. Crear un branch para trabajar

Una vez que tengas el código en tu máquina creá un nuevo branch dentro del repositorio. Por ejemplo:

git checkout -b add-new-feature

Luego trabajá sobre el código realizando las modificaciones necesarias y commiteando esos cambios hasta que creas que está listo.

4. Agregarse a la lista de colaboradores

Cuando ya tengas el código listo abrí el archivo Contributors.md del proyecto y agregá tu nombre al final de la lista de colaboradores (no olvides poner el link a tu usuario de Github).

Luego agregá los cambios y confirmalos con git commit -m Add <NAME> to Contributors list (agrega tu nombre en el comando).

5. Subir los cambios a tu repo en Github

Con los pasos anteriores ya está todo listo para subir los cambios a tu cuenta de Github. Ejecutá el siguiente comando para subir el branch creado (en este caso add-new-feature) al repositorio.

git push origin add-new-feature
6. Crear y enviar el pull request

Ya estas a un paso! Ahora en el repositorio de tu cuenta de Github presioná el botón Compare & Pull request que aparece en el inicio. La imagen a continuación puede ayudarte.

fork

En la siguiente pantalla te va a aparecer a la izquiera el repositorio y branch al cual querés enviar tus cambios. En este caso a la rama master del repo de Goto IoT. En la parte derecha aparece el repo y branch a partir del cual querés generar el pull request. En este caso es tu repositorio y la rama que querés enviar (add-new-feature para el ejemplo). En esta imagen podés ver representadas estas acciones.

fork

El último paso es redactar una nota acerca del pull request que estás generando. Esto permite entender los cambios que realizaste sin necesidad de analizar detenidamente el código. Podés copiar este template y modificarlo.

Hola! 

Les envío un pull request con los siguientes cambios/correcciones:

* Se agregó la feature XX que hace esto.
* Se agergó la feature YY que hace lo otro.
* Finalmente se agrego ZZ que sirve para aquello.

Saludos!
Nombre.

Finalmente presioná el botón Create pull request para enviarlo como podés ver en esta imagen.

fork

Vas a poder ver que en el repo de Goto IoT al que enviaste los cambios aparece tu pull request de manera similar a esta imagen.

fork

Felicitaciones

¡Excelente, tu pull request se encuentra creado! 🎉

Realmente apreciamos tu voluntad y esfuerzo en sumar un granito de arena a Goto IoT. Vamos a intentar revisar los cambios lo más pronto posible.

A partir de ahora podrías realizar cualquier de estas acciones.

  • Compartir tu contribución a través de nuestra comunidad abierta para que los demás miembros se enteren de tus cambios.
  • Compartir este trabajo en tus redes sociales.
  • Motivar a más personas que se sumen a colaborar.

Con estas colaboraciones no solo aportamos a una comunidad sino también al desarrollo personal, ya que este tipo de tareas son el pan de todos los días a la hora de trabajar con proyectos de código abierto.

Muchas gracias, sigamos adelante! 🚀