Este repositorio lo ayudará a practicar los conceptos básicos del flujo de GitHub y cómo trabajar en proyectos de código abierto.
Aquí hay un enlace a una presentación a GIT en general: https://docs.google.com/presentation/d/1vfsg__2-T7XJYGKFS9HFPKMAOMN1JE0V0H7GLYIY1AU/EDIT?USP=SHARING
Estos pasos suponen que ha instalado Git localmente, que ha creado una cuenta de GitHub y que le ha agregado su clave SSH local.
Bifurca este repositorio, usando el botón de la horquilla en la esquina superior derecha.
Clone su repositorio bifurcado localmente. git clone [email protected]:<your-github-handle>/git-tuto.git
Agregue el proyecto original como un repositorio lejano. git remote add upstream https://github.com/zaccharieramzi/git-tuto.git
Cree una nueva rama para agregar su nombre a la lista de personas que han participado en el tutorial. git checkout -b <your-name-or-pseudonym>
Agregue su nombre al archivo participants.csv . echo '<your-name-or-pseudonym>,n' >> participants.csv
Etapa y comete tus cambios. git add participants.csv && git commit -m'Added <your-name-or-pseudonym> to the participants file'
Empuja tu rama local a tu repositorio lejano. git push origin <the-name-of-your-branch>
Abra una nueva solicitud de extracción (PR): https://github.com/zaccharieramzi/git-tuto/compare. Tienes un ejemplo de relaciones públicas aquí.
Iterar con retroalimentación.
Una vez que el PR esté (aplastado y) fusionado, no olvide actualizar su repositorio local ( git checkout master && git pull upstream master ) y su repositorio distante ( git push origin master ).
Una vez que haya entendido cómo funciona el flujo GitHub, puede intentar participar en el tutorial de integración continua (CI). Pero primero, ¿qué es CI? CI es un proceso que se puede describir mejor como la prueba continua del código a medida que se agregan piezas. Esto asegura que una nueva adición a la base de código no altere inesperadamente el comportamiento del código.
Existen muchas herramientas, pero aquí usaremos solo Travis CI. Para configurarlo, solo necesita registrarse en su sitio web, agregar su repositorio a la lista de repositorios observados y luego agregar un archivo de configuración de Travis a su proyecto. El archivo de configuración de Travis es un archivo YAML que contiene una lista de instrucciones sobre cómo ejecutar las pruebas correctamente.
Esto supone que ha tomado los pasos 1-4 del tutorial GIT.
Agregue un archivo _function.py a la carpeta de funciones.
En este archivo, escriba una función simple que se pueda probar fácilmente. Un ejemplo es mi archivo de función. La función no tiene que ser sobre los números, pero puede ser sobre todas las estructuras de datos incorporadas que Python proporciona.
Agregue una prueba unitaria correspondiente para esta nueva función. Un ejemplo de una prueba unitaria correspondiente es mía.
Realice los pasos 6-10 del git-tutorial con la ligera excepción que necesita tener un mensaje de confirmación más adecuado.
Usted es libre de sugerir mejoras tanto en la presentación como en este tutorial utilizando los problemas de este repositorio. Una primera buena contribución podría ser, por ejemplo, agregar las pautas contribuyentes.