Khaganat-games/khanat_gamedev_guide
1
0
Fork 0
Code Issues 1 Pull requests Packages Projects Releases Wiki Activity

Explicitations autour du workflow de merge request

Browse source
This commit is contained in:
yannk 2023-03-05 11:24:36 +01:00
parent 47c568fa3b
commit 665223b0e8
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -237,13 +237,13 @@ Vous pouvez ensuite envoyer vos modifications locales sur votre dépôt distant
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 s’ouvre alors. Normalement vous aurez les deux dépôts corrects 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 ».
Une nouvelle page s’ouvre alors. Normalement vous aurez les deux dépôts corrects indiqués, à savoir votre dépôt de fork distant dans la partie gauche et le dépôt originel du projet dans la partie droite. Si ce n’est pas le cas, veillez à bien indiquer les dépôts et branches pertinents dans l’origine (à gauche) et la destination (à droite) : vous devez indiquer dans la partie gauche votre dépôt sur gitlab avec votre branche de travail (`preference-file-creation` dans notre exemple) et ce sera la branche `main` du projet principal qui sera la cible. Vous pouvez ensuite cliquer sur « compare branch and continue ».
Il est possible de bloquer la validation d’une merge request durant un temps d’amélioration (afin d’itérer après un premier retour par exemple). Dans ce cas, il faut indiquer `Draft:` à son début de titre. Il faudra alors appuyer sur le bouton `Mark as ready` pour permettre sa validation (détails dans [la documentation Gitlab](https://docs.gitlab.com/ee/user/project/merge_requests/drafts.html#mark-merge-requests-as-drafts)).
#### Page « New merge request »
Vous pouvez laisser le titre de votre commit ou le changer pour permettre de comprendre plus rapidement ce dont il s’agit. Vous pouvez compléter la description également. Vous pouvez laisser le reste tel qu’indiqué par défaut.
Vous pouvez laisser le titre de votre commit ou le changer pour permettre de comprendre plus rapidement ce dont il s’agit. Vous pouvez compléter la description également. Il faut cocher `squash commits when merge request is accepted` pour faire en sorte que l’historique des commits du dépôt principal soit plus simple, avec seulement le commit de merge. Vous pouvez laisser le reste tel qu’indiqué par défaut.
Puis vous cliquez sur « create merge request ».
@ -255,13 +255,18 @@ Si vous êtes suffisament impliquées dans le projet, vous aurez la possibiltié
Vous pourrez échanger avec la contributrice et les autres mainteneuses du dépôt principal dans l’espace « Activity ». Vous avez les onglets « Overview », « Commits », « Pipelines » et « Changes » qui permettent de suivre ce que la Merge request comporte comme contenu. Les réponses, remarques etc. apparaissent dans leur ordre chronologique par défaut, mais cela peut se filtrer/changer avec les paramètres dans le menu déroulant à droite.
Lorsque le contenu vous semble correct pour une fusion dans la base principale, mais que vous ne souhaitez atrtendre d’autres avis, vous pouvez cliquer sur « Approve ». Cela signalera juste aux autres utilisatrices que vous êtes d’accord pour le merge.
##### Les éléments à vérifier
La emrge request doit avoir sa case `squash commits when merge request is accepted` afin de réduire tous les ajouts à un seul commit dans l’historique de la branche principale.
Une merge request doit avoir un message de commit qui respecte les conventions (voir la section [Les commits](les-commits)).
Lorsque le contenu vous semble correct pour une fusion dans la base principale, mais que vous ne souhaitez attendre d’autres avis, vous pouvez cliquer sur « Approve ». Cela signalera juste aux autres utilisatrices que vous êtes d’accord pour le merge.
Lorsque vous pensez que la contribution doit être intégrée au projet, vous pouvez cliquer sur « Merge », en laissant les autres options telles que par défaut. Vous pouvez également estimer qu’il faut d’autres validations / « Approvals » avant de faire cette opération.
Si vous estimez que la contribution n’est pas adaptée et doit être refusée, vous pouvez cliquer sur « Close merge request » qui fermera la demande sans intégrer son contenu au dépôt principal.
### Les commits
#### Généralités