¿Como colaborar con código en el repositorio?

[MinusFour]

Hola, si estás perdido y no sabes como empezar a colaborar en el repositorio estas en el lugar adecuado.

El primer lugar a visitar antes de empezar cualquier aportación debe ser los issues de Github. En el puedes encontrar los puntos pendientes a resolver en los que se está trabajando de momento. Si consideras que hay otros puntos importantes a mencionar puedes abrir un nuevo issue y detallar la naturaleza del problema. Puedes empezar a trabajar sobre cualquiera de los issues pendientes aunque si no hemos verificado que sea un issue relevante hay una posibilidad que cualquier trabajo realizado para resolver el supuesto problema no sea aceptado si consideramos que no es sun problema.

Para empezar a trabajar sobre el issue es importante que crees un fork del repositorio, puedes usar este link para crear el fork. También puedes hacer click sobre el botón en la parte superior derecha para crear el fork.

Este fork es tu copia de trabajo en Github, en la cual puedes realizar cualquier cambio que creas necesario y se debería poder encontrar bajo la URL:

https://www.github.com/tu_usuario/web-nuevo

Por ejemplo, mi nuevo fork:

https://www.github.com/elhacker-net

En esta copia de trabajo tienes permisos de escritura para poder subir tus cambios sin alterar el repositorio original. Para poder trabajar sobre el repositorio es necesario que puedas autentificarte correctamente con github.com. Si no usas 2FA, tu usuario y contraseña debería ser suficiente.

Si usas 2FA es necesario que uses una llave SSH si usas SSH o un PAT para HTTPs. En mi opinión es mejor utilizar el protocolo SSH, pero sin lugar a duda generar un PAT es mucho más sencillo.

Para poder realizar cambios sobre el repositorio es necesario descargar el repositorio en nuestra maquina. Para esto utilizare un sistema con Linux. El primer paso es ir a nuestro fork bajo la URL (reemplazar tu-usuario por tu veradero usuario de github):

https://www.github.com/tu_usuario/web-nuevo

Y hacer click sobre el botón verde que dice "Code" y copiar la URL que aparece ahí. En mi caso utilizare SSH, pero ustedes pueden usar HTTPS.

De aquí es necesario clonar el repositorio en nuestro sistema usando la URL copiada. Aquí usare mi sistema con Linux:

Siguiendo nuestras reglas de contribución es necesario crear una nueva rama. De preferencia darle un nombre relevante a los cambios que se quieren introducir. Por ejemplo, yo quiero agregar un plugin de webpack para extraer CSS, así que le llamaré webpack-extract-css (nombres en ingles son recomendados pero no son necesarios). Las nuevas ramas siempre empezarán desde dev y no de cualquier otra rama.

Ahora puedo realizar cualquier cambio necesario. Como dije antes, quiero agregar un plugin para extraer el CSS del build de JS por webpack. Así que usare mini-css-extract-plugin. Una vez que hayas terminado tus cambios, es importante agregarlos a un commit. Primero los agregare al índice.

Ahora crear el commit.

Finalmente, es necesario empujar los cambios al fork.

Una vez que los cambios estén en el fork del repositorio nosotros podemos incluir esos cambios. Para esto va a ser necesario que se cree un pull request. Tendrán que ir a la sección de pull requests en el repositorio original y crear un nuevo pull request (usando el botón verde de "New Pull Request".

Es importante seleccionar las ramas y los repositorios adecuados. Para eso es necesario crear un pull request a comparar entre forks (hacer click sobre "compare across forks"), al final debes tener una imagen así:

El repositorio base, es este mismo repositorio y el repositorio head debe ser su fork. La rama base debe ser dev ya que de momento solo aceptamos pull requests en dev y la rama a comparar en el fork debe ser la rama recién creada y empujada a su fork. Damos click al botón verde a "Create Pull Request" y ahora nos entrega esta interface, donde tenemos que rellenar la información apropiada, por ejemplo:

Ahora que has terminado el pull request, nos toca a nosotros revisar el contenido del pull request y validar si es aceptable. Quizás sea necesario que agregues más cambios, quizás sea necesario que hagas un rebase. Dependerá de la situación.

Una vez que hayamos verificado todos los cambios que propones, incluiremos tu código dentro del repositorio, debes poder ver el cambio de "Open" a "Merged". En dado caso, felicidades, tu código fue aceptado y ahora está dentro del repositorio.

Esto debe ser considerado lo mínimo para poder colaborar cualquier cambio en el repositorio. Sin embargo, como hemos dicho anteriormente... No necesitas ser un programador, desarrollador web o diseñador para poder aportar. Usa los otros canales (issues, discusiones, foro, telegram, etc) para poder comentar opiniones e ideas que puedas tener.