Skip to content

Latest commit

 

History

History
240 lines (135 loc) · 8.82 KB

CONTRIBUIR.md

File metadata and controls

240 lines (135 loc) · 8.82 KB

¿Cómo contribuir?


Inicio Universidad Contribuir

Contribuir

¿Quieres contribuir y no sabes por dónde y cómo hacerlo? ¡No debes preocuparte! Hay todo tipo de formas de involucrarse con el proyecto y unos pocos consejos te ayudarán a sacar el máximo provecho.

¿En qué contribuir?

Visita nuestro tablón de tareas, es el lugar perfecto para empezar con algo. Si falta algo, añádelo.

¿Te gusta diseñar?

  • Reestructura los diseños para mejorar la usabilidad del proyecto
  • Reúne una guía de estilos para ayudar al proyecto a tener un diseño con consistencia visual

¿Te gusta escribir?

  • Escribe y mejora la documentación del proyecto
  • Escribe una traducción de la documentación del proyecto

¿Te gusta programar?

  • Comparte tu código para que de ese modo los demás puedan aprender de él
  • Pregunta si puedes ayudar a escribir alguna nueva funcionalidad

¿Te gusta ayudar a las personas?

  • Responde preguntas a las personas en los problemas abiertos
  • Ayuda a moderar los foros de discusión o canales de conversación

¿Te gusta ayudar a otros a programar?

  • Revisa el código que otras personas presentan
  • Escribe tutoriales sobre cómo puede resolverse una práctica de clase
  • Ofrécete como tutor de otro estudiante

Pasos para colaborar

  1. Haz un Fork del proyecto.

    En la esquina superior izquierda de la página encontrarás un botón, haz click en Fork.

  2. En GitHub, navega hacia el Fork que se te ha generado.

  3. Clona el proyecto.

    git clone https://github.com/YOUR-USERNAME/stuja

  4. Crea una rama, protegiendo de ese modo la rama master.

    git checkout -b "nombre-de-tu-rama"

    Puedes leer más información sobre el porqué de este paso en:

  5. Aporta tus mejoras al proyecto. ¡Ah!, y no olvides incluirte en la sección de Contribuidores: doc/CONTRIBUIR.md, universidad/README.md y README.md.

  6. Guarda los cambios.

    git add . 

git commit -m "Descripción del cambio que has realizado"

  7. Sube los cambios a GitHub.

    git push origin "nombre-de-tu-rama"

  8. En GitHub, haz un pull request haciendo click en el botón Compare & pull request.

  9. En la nueva ventana, describe los cambios que has añadido y señala por qué son importantes.

  10. Envia el pull request haciendo click en Create pull request.

Manténte al día

Deberías configurar tu repositorio local para que apunte al repositorio original de Stuja https://github.com/Stuja/stuja, para sincronizar cualquier cambio que se realicen en GitHub.

De este modo, siempre tendrás la última actualización de Stuja en tu repositorio local.

Pasos a seguir

  1. Lista tus repositorios remotos

    git remote -v
    origin	https://github.com/tu-usuario/stuja.git (fetch)
origin	https://github.com/tu-usuario/stuja.git (push)

  2. Crea un nuevo repositorio remoto

    git remote add upstream https://github.com/Stuja/stuja.git

    Ahora upstream apuntará al repositorio original de GitHub de Stuja.

  3. Verifica tus repositorios remotos

    git remote -v
    origin	https://github.com/tu-usuario/stuja.git (fetch)
origin	https://github.com/tu-usuario/stuja.git (push)
upstream	https://github.com/Stuja/stuja.git (fetch)
upstream	https://github.com/Stuja/stuja.git (push)

  4. Actualiza tu rama master

    git pull upstream master
    Desde https://github.com/Stuja/stuja
 * branch            master     -> FETCH_HEAD
Ya está actualizado.

Dudas 🙋

¿Has tenido algún problema con los pasos anteriores? No te preocupes, aquí te facilitamos ayudas para que te sea más fácil:

¿Sigues con dudas? Accede a nuestro grupo de Telegram y pregunta. Siempre hay miembros que te podrán ayudar mejor😉 .

Házte con un mentor

En la sección de Issues podrás ver que muchas tareas están por hacer y que algunas tienen la etiqueta E-mentor. En los issues etiquetados con E-mentor, un colaborador que tiene experiencia con el proyecto se ha ofrecido como voluntario para guiarte a través de la resolución del issue.

¡Es una idea maravillosa!

Y eso no es todo. Si tienes una idea y vas a necesitar un poco de ayuda en el proceso, házte con un mentor haciendo lo siguiente:

  1. Ve a la sección de Issues.

  2. Crea un nuevo issue pulsando en New issue

  3. Añade un título y una descripción a tu idea.

  4. Asígnate la tarea.

  5. Añade la etiqueta E-mentor.

¡Ya lo tienes! Un colaborador se pondrá en contacto contigo a través del chat del issue y podréis llevar a cabo esa idea que tienes en mente 😉 .

Alternativas de colabaración

Si quieres aportar algo al repositorio pero aún no te has animado a hacerlo directamente, hay otra manera en la que puedes colaborar:

Accediendo a nuestro grupo de Telegram y enviándonos tu aportación. Siempre hay miembros que podrán hacerlo por ti. Además, seguirás teniendo el reconocimiento en la sección de contribuidores.

Guía de estilo 🦋

Para una visualización homogénea del proyecto, lee nuestra guía de estilo. Si ves algo que se pueda mejorar, no dudes en aportar tu mejora.

Si la asignatura sobre la que vas a añadir contenido aún no tiene un directorio creado, créalo y usa nuestro template para el README.md de dicha asignatura.

Igualmente si vas a añadir soluciones sobre las prácticas, usa el template y sitúalo dentro de la carpeta universidad/asignatura/NOMBRE-DE-LA-ASIGNATURA/Prácticas.

Basta con rellenar los espacios entre corchetes [] con la información correspondiente.

¿Cómo escribir documentación?

La documentación esta escrita en formato Markdown, por su simplicidad, rapidez y portabilidad.

Existen muchos editores, y os invito que compartáis aquellos que vosotros utelicéis. Aquí algunos:

  • Typora. Para instalar y disponible para la mayoría de las plataformas.
  • Stackedit. Editor potente y online. Su interfaz gráfica hace muy sencillo editar los documentos.

Contribuidores ✍️

Todos aquellos que ayudaron a levantar el proyecto.

manuelalferez Delunado rgomez96 Davavico22
manuelalferez Delunado rgomez96 Davavico22