Merge pull request 'MilesTEG-TutoGitSourceTree' (#88) from MilesTEG-TutoGitSourceTree into master

Reviewed-on: https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/pulls/88

TUTO_Git_SourceTree.md

@@ -0,0 +1,140 @@
+Tutoriel pour Git avec SourceTree  <!-- omit in toc -->
+============
+Le but de ce tuto est d'expliquer comment faire des commits proprement sur le Gitea de Zoz. 
+
+## Table des matières  <!-- omit in toc -->
+- [1. Introduction & Installation](#1-introduction-installation)
+  - [1.1. Prérequis :](#1-1-prérequis)
+  - [1.2. Cloner le dépôt avec SourceTree :](#1-2-cloner-le-dépôt-avec-sourcetree)
+  - [1.3. Explications rapides des fonctions de SourceTree utilisées dans ce tuto](#1-3-explications-rapides-des-fonctions-de-sourcetree-utilisées-dans-ce-tuto)
+- [2. Créer une branche de travail `mon_pseudo-travail` depuis la branche `master`](#2-créer-une-branche-de-travail-mon-pseudo-travail-depuis-la-branche-master)
+    - [2.1. Méthode n°1 : depuis SourceTree](#2-1-méthode-n-1-depuis-sourcetree)
+    - [2.2. Méthode n°2 : depuis l'interface web de Gitea](#2-2-méthode-n-2-depuis-l-interface-web-de-gitea)
+- [3. Envoi du premier commit, et des suivants...](#3-envoi-du-premier-commit-et-des-suivants)
+- [4. Demande de fusion de notre branche `mon_pseudo-travail` avec `master`](#4-demande-de-fusion-de-notre-branche-mon-pseudo-travail-avec-master)
+
+## 1. Introduction & Installation
+
+Ce petit tuto va utiliser l'application SourceTree : [https://www.sourcetreeapp.com/](https://www.sourcetreeapp.com/).<br>
+J'ai essayer plusieurs clients Git pour windows et macOS, et la seule (parmis celles essayées) offre une interface graphique assez similaire sur ces deux plateformes, et est assez facile d'utilisation. Ce tuto sera donc en partie rédigé pour utiliser cette application.
+
+**Ce tuto va donc servir de guide pour contribuer au dépôt avec le moins possible de ligne de commande, voir aucune.**
+
+### 1.1. Prérequis :
+
+- Vous devrez aussi avoir installé Git pour windows (ou macos) : [https://git-scm.com/downloads](https://git-scm.com/downloads). Ça pourra être nécessaire si on passe par la ligne de commande.
+- Installer SourceTree. <br> Une fois Git installé, et SourceTree installé, aller dans les options de SourceTree pour vérifier que le Git utilisé est bien celui que vous venez d'installer (en externe du point de vue de SourceTree) :<br>
+[<img src="https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/SourceTree-Git-config.png" align="" height="500" />](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG/Tuto-Git-SourceTree/SourceTree-Git-config.png)<br>
+Tous les autres paramètres étant ceux par défaut.
+
+### 1.2. Cloner le dépôt avec SourceTree :
+
+[<img src="https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-05.png" align="" height="500" />](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG/Tuto-Git-SourceTree/Capture-05.png)<br>
+Une fois le dépôt cloné, on peut commencer à commiter comme un pro :D.
+Vous devriez avoir ce genre d'affichage :<br>
+[<img src="https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-06.png" align="" height="500" />](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG/Tuto-Git-SourceTree/Capture-06.png)<br>
+
+### 1.3. Explications rapides des fonctions de SourceTree utilisées dans ce tuto
+
+Dans ce tuto, nous n'allons pas utiliser beaucoup de fonctionnalités de SourceTree, mais voilà les principales :
+
+- **Bouton Valider** : permet d'afficher l'écran de validation du commit que l'on s'apprête à finaliser. On peut, et on doit, laisser un bref message indiquant sommairement ce que contient ce commit (en termes d'ajout, modification, etc...).<br>
+  En ligne de commande, ce serait : `git commit -m "ma super modif"`.
+- **Bouton Récupérer** : C'est le `git pull`, ça permet de récupérer dans la branche en cours le conteneur d'une branche distante :
+- **Bouton Envoyer** : C'est le `git push`, ça permet d'envoyer les modifications locales sur le dépôt distant. En général, je préfère utiliser la case à cocher "Envoyer les modifications vers origin/ma-brancheblabla" à l'étape de validation du commit (voir plus bas).
+- **Bouton Rapatrier** : Je l'utilise lorsque je suis sur la branche `master` pour récupérer les données et enlever de SourceTree les branches distantes qui ont été supprimées.
+- **Bouton Changer de branche** : C'est avec ce bouton que je crée une nouvelle branche depuis la de départ `master`.
+
+
+## 2. Créer une branche de travail `mon_pseudo-travail` depuis la branche `master`
+
+#### 2.1. Méthode n°1 : depuis SourceTree
+
+- Il faut tout d'abord se placer sur la branche master en double cliquant dessus.<br>
+![](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-10.png)
+- Ensuite, toujours choisir "Parent de la copie de travail" avant de créer la branche :<br>
+![](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-11.png)
+
+On est maintenant prêt à faire nos commit :<br>
+![](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-12.png)
+
+#### 2.2. Méthode n°2 : depuis l'interface web de Gitea
+
+![](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-01.png)<br><br>
+![](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-02.png)<br><br>
+![](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-03.png)<br><br>
+![](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-04.png)
+
+Si vous créer votre branche depuis Gitea, il faudra l'importer dans SourceTree.
+- Pour ce faire :
+  - soit vous double-cliquer sur la branche distance à rapatrier,
+  - soit vous fait un clic droit dessus :<br>
+![](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-07.png)
+
+- Ensuite vous cocher bien la case indiquer, et laisser le nom qui s'affiche pour la branche locale, puis valider par OK :<br>
+![](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-08.png)
+<br><br><br>
+
+**Une fois la branche créée, vérifiez bien que cette dernière est bien sélectionnée !**
+
+![](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-12.png)
+
+## 3. Envoi du premier commit, et des suivants...
+
+Vous pouvez maintenant créer vos dossiers/fichiers, faire les modifications sur les fichiers/dossiers existants.
+
+Une fois que vous arrivez à une étape clé, ou bien pour être sûr que votre travail soit "sauvegardé" sur le serveur, vous pouvez faire votre 1er commit.
+
+- Cliquez sur le bouton + :<br>
+  ![](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-14.png)
+- Puis choisir les élements à indexer :<br>
+  ![](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-16.png)
+- Puis on pense bien à écrire un commentaire et à cocher la case en bas pour que le commit soit envoyé sur le dépôt distant.<br>
+  Cette case est l'équivalent d'un `git push`.<br>
+  ![](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-17.png)
+
+Pour la rédaction de ce tuto, j'ai fait pas mal de commits ^^. Voilà çe que ça donne avec une vue :
+
+![](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-18.png)
+
+On voit même une branche (MilesTEG) que j'ai supprimé en cours de route... (ça rendait trop complexe la gestion des branches).
+
+## 4. Demande de fusion de notre branche `mon_pseudo-travail` avec `master`
+
+Une fois qu'on a fini de travailler sur notre branche, dernier commit fait, ou bien pour soumettre le travail fait à la relecture par les autres membres, on peut faire une demande de fusion.
+
+Je vais illustrer cela maintenant, même si au moment où je fais la capture, le tuto n'est pas entièrement terminé.
+
+- Pour faire cette demande de fusion, le plus simple est d'aller sur la [aller sur la page web des branches](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/branches) puis de cliquer sur le bouton "**Nouvelle demande de fusion**" de notre branche (il se peut que ce bouton s'intitule juste "**Demande de fusion**"):<br>
+![](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-19.png)
+<br>
+(On voit que j'ai 12 commits dans cette branche, je ne sais pas à quoi correspond le 0...)
+
+- Ensuite, on vérifie bien qu'on a la bonne branche de destination `master` (à gauche) et notre branche source `mon_pseudo-travail` :<br>
+![](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-20.png)
+
+- Étape suivante : (lisez le texte dans la capture)<br>
+![](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-21.png)
+<br><br>
+
+Si vous faites encore des commits avant de fusionner, vous les verrez apparaître à la suite des précédents et des modifications apportées à la demande de fusion (message, ajout d'étiquette, etc...):<br>
+![](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-23.png)
+
+- Dernière étape : Sélectionner quelques relecteurs dans la liste<br>
+![](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-24.png)
+
+- Si jamais vous avez cliquez sur WIP, quand vous aurez terminé vos modifications, il faudra cliquer sur le bouton "**Enlever le préfixe WIP**" pour fusionner votre branche avec `master`.
+![](https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/MilesTEG-TutoGitSourceTree/Tuto-Git-SourceTree/Capture-22.png)
+<br><br>
+
+Il ne vous reste plus qu'à attendre la validation par un relecteur, et qu'il fusionne votre branche avec la branche `master`.
+
+À l'issue de cette fusion, votre branche sera supprimée. Si vous vouliez continuer à travailler dessus, mettez-là en statut WIP, en postant un message indiquant votre intention.
+
+
+___
+Ça y est, c'est la fin du tutoriel :D 
+
+Merci d'avoir tout lu et tout suivi ;)
+
+Votre avis, conseils et idées d'amélioration sont les bienvenues. Vous pouvez faire ue branche et commiter dessus ^^ ou bien me demander directement sur Discord.