Travailler en équipe avec Git et Godot

Commencez par cloner, ouvrir, modifier et partager le projet. Vous pouvez utiliser des branches d’exploration aux noms explicites.

Les références aux issues deviennent obligatoires après la mise en place du backlog, selon les conventions GitLab.

Un membre prépare le projet commun dans le dépôt GitLab de l’équipe. Les autres récupèrent cette base par clonage.

Copiez l’URL de clonage depuis GitLab et remplacez URL_DU_DEPOT :

git clone URL_DU_DEPOT projet-equipe
cd projet-equipe

Configurez votre identité dans cette copie du dépôt :

git config user.name "Prénom Nom"
git config user.email "votre-adresse-associee-a-gitlab"

Dans le gestionnaire de projets Godot, utilisez Importer et sélectionnez le fichier project.godot indiqué dans le README. Laissez l’importation des ressources se terminer, puis lancez le jeu.

Chaque membre travaille dans sa propre copie du dépôt. Les échanges passent par GitLab avec push et pull.

Documentation : git clone.

Utilisez ce cas si la branche n’existe encore ni localement ni sur GitLab.

git switch main
git pull --ff-only
git switch -c 42-recommencer-partie

Adaptez le numéro et le nom à votre issue. Si la branche a déjà été créée depuis GitLab, utilisez le cas B.

L’option --ff-only refuse une mise à jour si les historiques ont divergé. Si une commande échoue, lisez son message avant d’exécuter la suivante.

Si la branche n’existe pas encore dans votre copie locale :

git fetch origin
git switch --track origin/42-recommencer-partie

Vous disposez maintenant d’une branche locale qui suit la branche correspondante sur GitLab.

git switch 42-recommencer-partie
git pull --ff-only

Le pull suppose que la branche suit déjà sa version sur GitLab. Si vous venez de créer une branche locale qui n’a jamais été publiée, le premier push de la section 4 établira ce lien.

Si le pull refuse une divergence, consultez la section 6.

Enregistrez votre travail, testez le résultat et arrêtez le jeu.

git status
git diff

Examinez aussi les nouveaux fichiers signalés par git status : ils ne sont pas affichés par git diff tant qu’ils ne sont pas indexés.

Sélectionnez les fichiers concernés. Les chemins suivants sont des exemples à adapter :

git add scenes/ecran_defaite.tscn scripts/ecran_defaite.gd

Ajoutez également les fichiers .uid, .import, ressources ou suppressions liés à la modification, lorsqu’ils sont présents.

Vérifiez ce qui sera réellement enregistré :

git diff --cached
git status

Puis créez le commit :

git commit -m "Ajouter le bouton Recommencer (#42)"

Regroupez des modifications cohérentes et utilisez les conventions de messages.

Lors du premier envoi de cette branche :

git push -u origin 42-recommencer-partie

Pour les envois suivants, depuis cette même branche :

git push

Vérifiez que vos commits apparaissent sur la bonne branche dans GitLab. Si un autre membre a envoyé des changements entre-temps, consultez la section 6 avant de réessayer.

Avant de changer d’ordinateur, envoyez vos commits. Sur l’autre ordinateur, récupérez ensuite la même branche.

Un push sur votre branche ne modifie pas main. Vous pouvez donc partager un travail encore incomplet, en signalant son état à l’équipe.

Faites cette mise à jour lorsque votre travail doit être vérifié avec les dernières contributions intégrées. Commencez avec Godot fermé et un répertoire de travail propre.

git switch 42-recommencer-partie
git fetch origin
git merge origin/main -m "Intégrer les changements de main (#42)"

Cette opération met à jour votre branche de travail. Elle ne fusionne pas votre travail dans main.

En cas de conflit, suivez la section 6. Sinon, rouvrez Godot, vérifiez le résultat combiné, puis faites un push.

Après l’intégration, avec Godot fermé et vos fichiers locaux enregistrés dans des commits :

git switch main
git pull --ff-only

Rouvrez le projet et vérifiez le jeu complet. Créez une nouvelle branche pour le prochain travail.

Avant chaque livrable, demandez à un autre membre de vérifier la version exacte qui sera présentée, à partir d’un nouveau clone :

git clone URL_DU_DEPOT verification-jeu
cd verification-jeu
git switch --detach SHA_DU_COMMIT

Remplacez URL_DU_DEPOT par l’adresse du dépôt et SHA_DU_COMMIT par l’identifiant du commit indiqué dans le support de présentation.

Cette copie sert aux vérifications. Poursuivez le développement dans votre copie habituelle, sur une branche de travail.

Suivez les instructions du README à cette révision pour repérer les fichiers oubliés et les étapes manquantes.

Lors des premiers livrables, complétez progressivement ces instructions. À partir du livrable 2, le guide doit permettre à une autre équipe de lancer cette version en autonomie sous Windows, macOS et Linux. Vérifiez la procédure sur les trois systèmes, puis maintenez-la à jour.

Si le message indique une divergence ou un rejet non-fast-forward, un autre membre a peut-être publié des commits sur la même branche.

Depuis la branche concernée, avec Godot fermé et un répertoire de travail propre :

git fetch origin
git merge origin/42-recommencer-partie -m "Intégrer le travail partagé (#42)"

Résolvez les éventuels conflits, vérifiez le résultat dans Godot, puis faites un push.

Cette opération récupère les contributions à votre branche. La fusion de origin/main répond à un autre besoin.

Si la divergence concerne main, ou si le message signale un problème d’accès ou de connexion, demandez de l’aide sur ce problème précis. Ne forcez pas le push.

1. Gardez Godot fermé pendant la résolution des conflits.

2. Utilisez git status pour identifier les fichiers concernés.

3. Discutez avec les auteurs des changements pour déterminer le résultat à conserver.

4. Corrigez les fichiers et retirez les marqueurs de conflit.

5. Une fois tous les fichiers cohérents, rouvrez Godot et vérifiez les scènes et les comportements concernés.

6. Enregistrez, indexez les fichiers résolus avec git add, puis terminez la fusion :

git commit -m "Résoudre les conflits de la branche (#42)"

Pour une scène .tscn, le choix automatique de toute une version peut effacer le travail d’un autre membre. Vérifiez le résultat ensemble et demandez de l’aide si sa structure est difficile à comprendre.

Pour abandonner une fusion encore en cours, commencée avec un répertoire propre :

git merge --abort

Cette commande abandonne aussi les modifications faites pour résoudre les conflits. Elle ne sert pas à annuler une fusion déjà terminée. Fermez Godot avant de l’exécuter.

Vérifiez ensemble :

• La version exacte de Godot et la branche utilisées.

• La présence des derniers commits sur GitLab.

• Les fichiers non suivis signalés par git status sur la machine où le jeu fonctionne.

• Les ressources sources et leurs fichiers .import et .uid.

• La casse des noms de fichiers et les chemins utilisés.

Laissez Godot terminer l’importation et lisez la première erreur utile. Corrigez le dépôt ou le README, puis reprenez la vérification depuis un nouveau clonage.

Examinez git status et git diff avant de créer un commit. Vérifiez si cela correspond à une autre version de Godot, à des fins de ligne différentes ou à une modification volontaire des paramètres d’importation.

Si .godot/ apparaît dans les fichiers à envoyer, vérifiez le .gitignore. Une règle d’exclusion ne retire pas automatiquement de Git des fichiers déjà suivis : signalez ce cas pour le corriger ensemble.

Conservez les changements que vous comprenez et qui sont nécessaires au projet. Faites examiner les autres avant de les supprimer ou de les intégrer.