ProducteurDocumentationPartenaireCommitGithubForkClone

Demander la fusion au dépôt principal

  • Producteur

  • Documentation

  • Partenaire

  • Commit

  • Github

  • Fork

  • Clone

Dernière modification le

Cette page explique la procédure pour fusionner vos modifications faites en local avec le dépôt principal de la documentation de Cartes.gouv.fr.

Avant de confirmer la fusion, vérifiez que le dépôt principal n’ait pas pris d’avance sur votre fork : voir Étapes préalables aux modifications.

1 - Enregistrer #

Pensez à bien enregistrer toutes vos modifications, sinon elles ne seront pas prises en compte dans la suite de la procédure. Dans Visual Studio un petit rond apparait à côté du nom du fichier si celui-ci a été modifié et pas encore enregistré. Image décrivant un fichier non enregistré dans Visual Studio

2 - Passer en revue les modifications #

Gardez l’invite de commande Git Bash utilisée pour faire tourner la prévisualisation avec Eleventy ouvert à part. Ouvrez une nouvelle invite de commande Git Bash à la racine du projet.

Dans la nouvelle invite de commande Git Bash, lancez la commande suivante :

git status

Cela vous résumera toutes les modifications que vous avez faites sur votre clone local.

Les fichiers non-enregistrés peuvent ne pas apparaitre dans la liste des modifications.

Image décrivant le résultat de la commande git status

3 - Choisir les fichiers à fusionner #

Vous pouvez soit ajouter toutes vos modifications avec la commande suivante :

git add .

Soit ajouter uniquement certains fichiers un à un avec la commande suivante :

git add content/fr/partenaires/partenaireABC/.../monfichier.md

4 - Pousser les modifications sur votre fork #

Il faut maintenant transmettre vos modifications locales à votre fork sur github. Pour cela lancez la commande suivante pour créer un nouveau paquet (commit) :

git commit -m "un message court décrivant la modification faite"

Transférez ensuite votre commit à votre fork avec la commande suivante :

git push --set-upstream origin nom-de-votre-branche

À ce moment, si vous voulez ajouter d’autres modifications à cette branche avant la fusion au dépôt principal, il suffira de repasser les commandes add, commit et push telles que présentées ci-dessus.

Vous pouvez voir sur le github de votre fork que celle-ci est à présent en avance de commit par rapport au dépôt principal : Image décrivant l’avance du fork sur le dépôt princiapl

5 - Demander une pull request #

La dernière étape consiste à demander au dépôt principal d’accepter vos modifications, il s’agit de la pull request (ou de la demande de merge).

En restant sur la même page github, cliquez sur « Contribute » puis sur « Open pull request »

Ajoutez un titre et une description concise puis cliquez sur « Create pull request ». Image décrivant la demande de pull request Un autre membre du projet devra alors vérifier la demande et l’accepter. Dès que cela sera fait, les modifications apparaitront sur le site.

6 - Supprimer la branche #

Une fois que la pull request a été acceptée, il faudra supprimer la branche.

Une pull request acceptée apparaitra en violet avec cette icône : Image décrivant une pull request acceptée Pour supprimer une branche, il suffit de se rendre sur github, sur votre fork, et de cliquer sur « Branch » : Image décrivant commment accéder à ses branches sur github Il vous suffit alors de supprimer la branche concernée par la pull request acceptée.


Vous avez terminé de créer et de modifier vos pages de documentation ! N’hésitez pas à parcourir le site pour découvrir les autres fonctionnalités de Cartes.gouv et de sa documentation.


Pour aller plus loin

Si vous souhaitez avoir plus de détails sur l’utilisation des pull request : Documentation github

Paramètres d'affichage

Choisissez un thème pour personnaliser l’apparence du site.