git tuto

Tutoriel GIT

Ce référentiel vous aidera à pratiquer les bases du flux GitHub et comment travailler sur des projets open source.

Voici un lien vers une présentation à Git en général: https://docs.google.com/presentation/d/1vfsg__2-t7xjygkfs9hfpkmaomn1je0v0h7glyiy1au/edit?usp=sharing

Mesures

Ces étapes supposent que vous avez installé Git localement, que vous avez créé un compte GitHub et y avez ajouté votre clé SSH locale.

1. Fourk ce dépôt, en utilisant le bouton de la fourche dans le coin supérieur droit.

2. Clone votre repo fourchu localement. git clone [email protected]:<your-github-handle>/git-tuto.git

3. Ajoutez le projet d'origine comme un dépôt éloigné. git remote add upstream https://github.com/zaccharieramzi/git-tuto.git

4. Créez une nouvelle branche pour ajouter votre nom à la liste des personnes qui ont participé au tutoriel. git checkout -b <your-name-or-pseudonym>

5. Ajoutez votre nom au fichier participants.csv . echo '<your-name-or-pseudonym>,n' >> participants.csv

6. Scène et commettez vos changements. git add participants.csv && git commit -m'Added <your-name-or-pseudonym> to the participants file'

7. Poussez votre branche locale vers votre dépôt lointain. git push origin <the-name-of-your-branch>

8. Ouvrez une nouvelle demande de traction (PR): https://github.com/zaccharieramzi/git-tuto/compare. Vous avez un exemple PR ici.

9. Itérer avec commentaires.

10. Une fois le PR (écrasé et) fusionné, n'oubliez pas de mettre à jour votre référentiel local ( git checkout master && git pull upstream master ) et votre dépôt lointain ( git push origin master ).

Tutoriel d'intégration continue

Aperçu de l'intégration continue

Une fois que vous avez compris le fonctionnement du flux GitHub, vous pouvez essayer de participer au tutoriel d'intégration continue (CI). Mais d'abord, qu'est-ce que CI? CI est un processus qui peut être mieux décrit comme le test continu du code à mesure que les pièces y sont ajoutées. Cela garantit qu'un nouvel ajout à la base de code ne modifie pas de façon inattendue le comportement du code.

De nombreux outils existent, mais nous n'utiliserons ici que Travis CI. Pour le configurer, vous avez juste besoin de vous inscrire sur leur site Web, ajoutez votre référentiel à la liste des référentiels regardés, puis ajoutez un fichier de configuration Travis à votre projet. Le fichier Travis Config est un fichier YAML contenant une liste d'instructions sur la façon d'exécuter les tests correctement.

Mesures

Cela suppose que vous avez pris les étapes 1 à 4 du tutoriel GIT.

1. Ajoutez un fichier _function.py au dossier Fonctions.

2. Dans ce fichier, écrivez une fonction simple qui peut être facilement testée. Un exemple est mon fichier de fonction. La fonction ne doit pas être sur les nombres mais peut concerner toutes les structures de données intégrées que Python fournit.

3. Ajoutez un test unitaire correspondant pour cette nouvelle fonction. Un exemple de test unitaire correspondant est le mien.

4. Effectuez les étapes 6-10 du tutorial Git avec la légère exception dont vous avez besoin pour avoir un message de validation plus adapté.

Contributif

Vous êtes libre de suggérer des améliorations à la fois sur la présentation et sur ce didacticiel en utilisant les problèmes de ce dépôt. Une première bonne contribution pourrait être par exemple pour ajouter les directives contributives.