El material de esta materia es abierto, lo cual quiere decir que cualquier persona puede usarlo para sus propios fines pedagógicos, y colaborativo, con lo cual contribuciones de alumnos son bienvenidas. Eso significa que los estudiantes también pueden ayudar a mejorarlo.
Te invitamos a contribuir en cualquiera de los siguientes casos:
Errores de tipeo u ortográficos
Links que no funcionan
Explicaciones poco claras o incorrectas
Código que no funciona
Material adicional que sería útil
¿Por qué fomentar contribuciones?¶
Además de mejorar el material del curso, esto también es una buena forma de practicar el workflow de colaboración con Git y GitHub, que es una herramienta clave en computación científica. Este curso intenta acercarse a la forma en que realmente se produce conocimiento científico y software:
Trabajo colaborativo
Revisión por pares
Mejora continua del material
Incluso pequeñas correcciones ayudan muchísimo a mejorar el curso para todos los estudiantes e interesados. Además, tu nombre quedara para siempre en el repositorio del curso por haber contribuido y aportado cambios al mismo.
Reportar un problema (Issue)¶
Si encontrás un problema o querés sugerir una mejora, lo más simple es abrir un issue en GitHub. Un issue sirve para reportar errores, proponer mejoras, hacer preguntas sobre el material y discutir cambios antes de implementarlos.
Proponer cambios al material (Pull Request)¶
Si querés corregir o mejorar directamente el contenido del curso, podés directamente enviar un Pull Request (PR). Un Pull Request propone cambios al repositorio original y permite que el instructor revise el cambio antes de integrarlo.
El flujo típico para contribuir a un repositorio en GitHub es el siguiente:
1️⃣ Crear un fork del repositorio¶
Ir al repositorio del curso en GitHub y hacer click en fork. Esto crea una copia del repositorio en tu propia cuenta. Podes encontrar información crear un fork en el siguiente link.
2️⃣ Clonar tu fork y trabajar localmente¶
Cloná tu repositorio en local y realiza nuevos cambios en local. Recomiendo crear una nueva branch en local para realizar los cambios.
3️⃣ Guardar los cambios y agregarlos a GitHub¶
Este es la secuencia clásica git add, git commit y git push donde se agregan los cambios nuevos a tu versión local del repositorio y luego remota (GitHub).
4️⃣ Abrir un Pull Request¶
Desde GitHub (la página web):
Abrí un PR. Podes encontrar más información de como abrir un PR en el siguiente link.
Seleccioná el repositorio original como destino.
Agregá al instructor como reviewer, asi puedo avaluar los cambios y potencialmente dar feedback sobre más cambios.