---

Principe #

Afin de partir sur des bases saines il est conseillé de mettre à jour votre fork (duplication github) et votre clone local afin qu’ils soient identiques au dépôt principal. Une fois cela fait, vous pourrez être sûr que les modifications que vous proposez ne viennent pas en conflit avec d’autres modifications récentes.

Changer son pseudonyme sur github #

Par défaut github génère votre pseudonyme à partir des informations de votre ordinateur. Pour modifier le pseudonyme et le courriel à utiliser (qui seront visibles par tous les contributeurs), lancez les commandes suivantes sur Git Bash :

git config --global user.name "MonPseudoGithub"
git config --global user.email mail@domaine.fr

Mettre à jour votre fork #

Rendez-vous sur la page de votre fork. Github affiche au dessus de la liste des dossiers et fichiers l’état de synchronisation de votre fork (commits en avance ou en retard)

Si votre fork a du retard sur le dépôt principal, vous pouvez cliquer sur le bouton « Sync fork » directement pour le mettre à jour.

Créer une branche #

Afin de permettre d’effectuer plusieurs modifications en parallèle et de facilliter la synchronisation entre collaborateurs, il est conseillé de travailler avec des branches. Par défaut votre fork/duplication contient une seule branche : la branche principale (main)._

Si ce n'est pas votre première contribution, vous êtes peut-être resté sur une branche de votre contribution précédente. Retournez sur la branche main.

git checkout main

Assurez-vous que votre branche main est à jour sur votre poste de travail avant de créer une nouvelle branche.

git pull

Choisissez un nom de branche parlant, qui correspond au périmètre des modifications que vous souhaitez faire, puis lancez la commande suivante dans l’invite de commande Git Bash :

git checkout -b nom-de-la-nouvelle-branche

Cette commande créera une nouvelle branche et vous y placera : « (nom-de-la-nouvelle-branche) » est indiqué dans l’invite de commande au lieu de « (main) » :

Répercutez ensuite la création de cette branche sur github, en lançant la commande suivante :

git push origin nom-de-la-nouvelle-branche

Pour lister les branches existantes il faut lancer la commande suivante :

git branch -l

Vous pouvez alors naviguer entre les branches existantes avec la commande suivante :

git checkout nom-de-la-branche

Mettre à jour votre clone local #

Vous reprenez vos modifications alors que le dépôt principal a été modifié depuis la création de votre branche ? Dans ce cas il faut mettre à jour votre branche github (cf. 3. Mettre à jour votre fork), puis mettre à jour votre clone en local.

Mettez de côté les modifications locales avec la commande suivante :

git stash

Ainsi elles ne seront pas surchargées par la mise à jour.

Importez la mise à jour avec la commande suivante :

git pull

Enfin, réappliquez les modifications locales sauvegardées avec la commande suivante :

git stash apply

Exécuter Eleventy pour construire le site #

Cette procédure permet de prévisualiser votre clone local et toutes les modifications que vous y apportez dans votre navigateur, avant d’en demander la fusion finale au dépôt principal. La prévisualisation est disponible sous l’adresse http://localhost:8080/fr.

Eleventy est le logiciel utilisé pour construire le site. Il transforme les fichiers markdown ou nunjucks du dossier « content » en pages html à l’aide des gabarits du dossier « _includes ». Ensuite Pagefind indexe le contenu de ces pages pour que le moteur de recherche du site soit fonctionnel.

À l’issu de cette commande, le dossier « _site » est rempli ou modifié avec un contenu html, visualisable dans un navigateur.

Lancez la commande suivante :

npm start

Cette commande rend le site disponible à l’adresse http://localhost:8080/fr et reste active, à l’écoute des changements que vous effectuez dans le projet. Normalement cette commande lance automatiquement la commande npm run build.

Le site est ainsi maintenu à jour en même temps que vous modifiez des fichiers. Mais les contenus modifiés ne sont pas indexés pour la recherche et il peut arriver que certaines modifications ne soient pas immédiatement prises en compte. Dans ce cas, arrêtez le site (« Ctrl+C » dans l’invite de commande Git Bash) et relancez les 2 commandes précédentes : npm run build puis npm start.

---

Votre site local est à l’écoute ! Rendez-vous page suivante pour commencer à faire des modifications.

---