docs: adding merge request informations

This commit is contained in:
yannk 2023-01-18 11:11:00 +01:00
parent 82e4496042
commit dad04254ad

View file

@ -155,7 +155,7 @@ Cela permet à chaque contributrice de travailler en local via son propre fork d
### Forker sur gitlab / cloner en local
#### Forker : copie distante
En cliquant sur le bouton « Fork » sur le projet principal, vous allez créer une copie distante sur la forge Gitlab, ce sera votre dépôt de développement depuis lequel vous pourrez opérer des emrge request. Vous pouvez le gérer comme bon vous semble, mais dans le doute, vous pouvez laisser les options proposées par défaut si vous comptez simplement vous en servir comme base pour contribuer au code.
En cliquant sur le bouton « Fork » sur le projet principal, vous allez créer une copie distante sur la forge Gitlab, ce sera votre dépôt de développement depuis lequel vous pourrez opérer des merge request. Vous pouvez le gérer comme bon vous semble, mais dans le doute, vous pouvez laisser les options proposées par défaut si vous comptez simplement vous en servir comme base pour contribuer au code.
### Cloner : copie locale
Une fois votre dépôt distant créé (appelé _origin remote_ dans le jargon Git), vous allez le copier sur votre ordinateur local pour travailler, cela se fait via la commande `git clone`.
@ -171,11 +171,11 @@ Une étape essentielle est ensuite dajouter le dépôt principal sur une bran
git remote add upstream ssh://git@port.numenaute.org:3543/khaganat/mmorpg_khanat/khanat_gamedev_guide.git
git fetch upstream
Ces commandes passées lors de la création vous permettront de mettre toute branche de votre dépôt local en tapant :
Ces commandes passées lors de la création vous permettront de mettre à jour toute branche de votre dépôt local en tapant :
git pull --rebase upstream main
Loption `rebase` nest pas obligatoire, mais sera nécessaire dans notre flux de travail.
Loption `rebase` nest généralement pas obligatoire, mais sera nécessaire dans notre flux de travail.
Et si jamais vous souhaitez ensuite mettre à jour votre dépôt distant (votre _fork_) :
@ -201,7 +201,8 @@ Il faudra veiller à sa mise à jour régulière en tapant la commande :
git pull --rebase upstream main
### Gestion des branches
Pour implémenter votre code, il va falloir créer une branche dédiée, depuis la branche `main` :
Pour implémenter votre code, il va falloir créer une branche dédiée, depuis la branche `main`. Vérifiez que vus êtes bien sur la bnranche `main` avant de la créer car cest de celle-ci, la plus à jour possible depuis `upstream` (la branche `main` distante du dépôt principal), que vous devez travailler :
git branch preference-file-creation
@ -227,7 +228,32 @@ En cas de doute, si vous pensez avoir fait une erreur, vous pouvez annuler toute
git rebase --abort
### Le merge request
### Le merge request
#### Envoyer ses modifications locales sur son propre dépôt de fork, distant
Une fois vos modifications réalisées sur votre branche, si cela fait un moment quelle na pas été mise à jour par rapport au projet principal, vous pouvez vous assurer que vos modificatins sont prises en compte en dernier (et ne provoquent pas de conflit) en tapant :
git pull --rebase upstream main
Vous pouvez ensuite envoyer vos modifications locales sur votre dépôt distant `origin` dans la branche sur laquelle vous travaillez :
git push origin preference-file-creation
#### Faire la demande de merge request
Vous devez vous connecter avec votre compte sur le serveur gitlab, aller dans votre fork distant et là, cliquer sur « merge request » dans la colonne de gauche. Puis vous cliquez sur « New merge request ».
Une nouvelle page souvre alors. Normalement vous aurez kles deux dépôts corects indiqués, à savir votre fork distant dans la partie gauche et le dépôt originel du projet dans la partie droite. Vous devez indiquer dans sa partie gauche votre branche de travail (`preference-file-creation` dans notre exemple) et ce sera la branche `main` du projet principal qui sera la cible (complété ainsi par défaut si tout va bien). Vous pouvez ensuite cliquer sur « compare branch and continue ».
#### Page « New merge request »
Dans le titre, veillez à ajouter « Draft: » avant la description de façon à garantir que la branche ne sera pas mergée avant dêtre validée formellement. Vous pouvez laisser le titre de votre commit ou le changer pour permettre de comprendre plus rapidement ce dont il sagit. Vous pouvez compléter la description également. Attention, il faut suivre les [recommandations de rédaction des commits](#les-commits) car cela générera le commit de merge avec ce contenu. Vous pouvez laisser le reste tel quindiqué par défaut.
Puis vous cliquez sur « create merge request ».
À partir de là, vous pourrez échanger avec les responsables du dépôt principal dans lespace « Activity ». Vous avez les onglets « Overview », « Commits », « Pipelines » et « Changes » qui permettent de suivre ce que la Merge request comporte comme contenu.
### Les commits
#### Généralités