Pourquoi GitHub ?

Contrairement à un FTP ou un DropBox, cette plateforme nous permet de travailler sur le même projet, sans qu'on ne puisse écrire du code les uns par dessus les autres. Le principe est simple ; voyons le code comme un arbre.

Le code final constitue le tronc de cet arbre. (on l'appelle le "master")

Lorsqu'un créateur veut créer ou modifier du code, il crée une branche temporaire. Une fois que le créateur a fini de travailler sur son projet (nouvelle quête, nouveau Skript, ...) et qu'il est prêt à être intégré au tronc principal il peut en faire la demande. (un "pull request")

Chaque demande sera alors examinée par la communauté et on peut en discuter, améliorer, aider ou changer à nouveau la proposition. Seulement une fois que le code a été validé par tous, il pourra être intégré dans le tronc principal. (entendez le "master")

Les quelques lignes ci-dessous ont pour but de vous guider dans ce processus.

---

Pré-requis

1 - Vu que nous n'utilisons que des fichiers .yml et .sk, le plus facile est de travailler, comme à notre habitude sur Notepad++. (ici)

2 - Il faut avoir un compte GitHub (je ne vous ferais pas l'offense d'un lien).

3 - Avoir téléchargé et installé GitHub Desktop pour plus de facilité. (ici)

---

Installer un clone local

1 - Lorsque vous avez reçu votre invitation de collaboration sur le projet, lancez GitHub Desktop. Cliquez sur le "+" en haut à gauche. Gaia devrait être présent comme sur l'image ci-dessous.

Pour obtenir une invitation de contribution au GitHub, renseignez-vous auprès de Hollish.

Cliquez sur le "Gaia".
On devrait vous demander de définir le dossier local de code. Choisissez le judicieusement, ce sera comme un dossier DropBox, synchronisé avec le site sur lequel se trouve le code.

2 - Créez une nouvelle branche en cliquant sur l'icône avec les trois bulles vides, en haut à gauche. Donnez votre nouvelle branche un nom distinctif (votre psuedo par exemple).

Bravo ! Vous êtes prêt à modifier le code !

3 - Cliquez ensuite sur "update from master" en vous assurant d'être bien dans votre branche. Il est crucial de ne jamais travailler directement dans la branche "master". Sur l'image au dessus, vous voyez la branche "Hollish" juste à droite du symbole pour créer une nouvelle branche. Vous devriez avoir le code dans votre dossier local, qui devrait ressembler à ceci :

---

Modifier le code et le mettre sur GitHub

1 - Il vous suffit désormais de modifier vos fichiers dans votre dossier local avec notepad++. Enregistrez vos modifications. Ces modifications devraient apparaître automatiquement sur GitHub Desktop ;

2 - L'image au dessus montre que j'ai ajouté (en vert) un message et que j'en ai retiré un autre (rouge) dans le fichier events.yml de hollish.
Pour synchroniser vos fichiers avec le GitHub, cliquez sur "sync" en haut à droite.

Une fois que vous avez terminé votre session de travail, vous devez effectuer un commit pour définitivement intégrer votre code dans votre branche.

Un commit se fait en remplissant le formulaire "Summary" et "Description", en dessous de la liste des modifications que vous avez effectuées. Cliquez ensuite sur "Commit to" et assurez vous que ce soit dans votre branche.

3 - Votre code est maintenant synchronisé avec le site, sur lequel vous pouvez consulter le code final dans master, ainsi que les autres branches et tous les commit qui ont été effectués dans toutes les branches. En français ça donne "regarder comment les autres ont modifié leur code" ;P

4 - Finalement, vous avez commit tous vos changements, votre quête ou nouveau skript est prêt pour être merge avec le master. Pour merge votre branche (entendez "fusionner votre travail avec le code du master") votre devez créer un pull request.

Même processus qu'un simple commit, mais cette fois votre demande sera soumise à l'approbation de la communauté. Le bouton pour créer un pull request se situe en haut à droite de l'interface de GitHub Desktop. Vous pourrez vous même suivre les demandes de pull request des autres sur le site, dans l'onglet du même nom.
Une fois qu'un pull request est approuvé par au moins 1 autre collaborateur, il pourra être intégré dans le master. Vous devez impérativement être à jour de master avant de pull request !

5 - BRAVO ! :tada: Votre branche est intégré dans l'arbre ! Plus qu'à faire la fête !
Vous pouvez maintenant à nouveau "Update from master" pour mettre à jour votre fichier local avec les dernières créations des autres collaborateurs ! =)

---

Notes

• Ne jamais commit directement dans le master.
• Rester à jour du master pour ne pas avoir de conflits lorsque vous demandez un pull request.