Aller au contenu principal

Méthodes avancées pour contribuer sur Github

Maintenant que votre environnement de travail est installé, vous pouvez commencer à effectuer des actions pour contribuer au MDN. Avant tout, pensez à lire les Règles d'écritures et les Règles de conduite avant de contribuer.

Gérer les liens distants aux dépôts​

Avant de modifier des pages et de les proposer, l'exemple suivant du dépôt translated-content vous présente comment lier le dépôt principal et le dépôt que vous avez bifurqué précédemment, mais vous pouvez appliquer ceci à d'autres dépôts.

Lorsque vous clonez le dépôt bifurqué sur votre machine, vous créez un lien vers le dépôt distant que Git appel « remote » en anglais. Préférez cloner le dépôt principal et ajouter votre dépôt bifurqué comme lien secondaire.

Pourquoi faire comme ça :

  1. Le dépôt principal vous permet de récupérer le contenu récent facilement. Si vous utilisez l'outil de bureau de GitHub, il va vous proposer automatiquement de récupérer les dernières fusions.
  2. Votre dépôt de travail est disponible par le biais d'une commande pour y envoyer les branches et n'a pas besoin d'être le dépôt en « origine ».

Voici donc comment ajouter en dépôt secondaire votre version bifurquée du dépôt des traductions :

BASH
git remote add translation https://github.com/<votre-utilisateur>/translated-content.git

Si vous faites la commande suivante, vous verrez que vous avez 2 liens distants :

BASH
git remote -v

Vous devriez voir quelque chose comme ceci :

origin  https://github.com/mdn/translated-content.git (fetch)
origin  https://github.com/mdn/translated-content.git (push)
translation  https://github.com/<votre-utilisateur>/translated-content.git (fetch)
translation  https://github.com/<votre-utilisateur>/translated-content.git (push)

Récupérez les mises à jour du dépôt qui contrôle les contenus publiés depuis origin et publiez vos modifications vers translation.

Sur GitHub, vous pouvez mettre à jour votre dépôt bifurqué pour que sa branche main soit identique avec celle du dépôt d'origine grâce au bouton Sync fork disponible sur la page de votre dépôt bifurqué. Cela vous permet ensuite de synchroniser votre dépôt localement aussi pour que vos deux branches main soient à jour sur votre machine avec :

BASH
git fetch translation -p

Que fait cette commande :

  • Elle récupère l'état de tous vos branches du dépôt bifurqué.
  • Elle supprime la liaison des branches locales qui ont été supprimées du dépôt bifurqué. Cependant, vous devez supprimer les branches manuellement côté machine.

Ajouter ou modifier du contenu​

Comme nous l'avons expliqué concernant les chemins vers les fichiers, vous allez devoir travailler selon les chemins des pages. De ce fait, pour modifier une page, ou ajouter une page, vous devez le faire de manière à ce que les dossiers correspondent au chemin de la page dans slug.

Pour reprendre l'exemple de l'attribut universel HTML title, le chemin vers son fichier index.md se trouverait :

Structure vers « files/fr/web/html/reference/global_attributes/title/index.md »
📂 files/fr
└─ 📂 web
   └─ 📂 html
      └─ 📂 reference
         └─ 📂 global_attributes
            └─ 📂 title
               └─ 📄 index.md

Afin de créer ou modifier une page, comme présentée ci-dessus, vous devrez donc créer la même structure de dossier jusqu'au fichier index.md qui contiendra le contenu de la page. Les pages doivent être structurées comme présenté dans notre guide sur la page de garde.

Par exemple, la page de garde de notre exemple est le suivant :

files/fr/web/html/reference/global_attributes/title/index.md
---
title: "Attribut HTML universel : title"
short-title: title
slug: Web/HTML/Reference/Global_attributes/title
l10n:
  sourceCommit: 5e815d522e796fb2209fa8470616b37e31c572b4
---

<!-- … -->

Une fois que vous avez créé ou modifié la page souhaitée, vous devrez faire un instantané des modifications comme suit :

git add .
git commit -m "chore(fr): votre message d'instantané ici"
Remarque

Assurez-vous ne bien avoir créé une branche avant de faire votre instantané. Les changements d'une branche main vers une branche main ne sont pas autorisés, et votre Requête de tirage sera fermée.

git switch -c <votre-branche>

Puis pour que vos modifications soient fusionnées, il faut les pousser sur votre dépôt bifurqué et créer une Requête de tirage sur le dépôt principal.

git push <votre-remote> <votre-branche>

Publier la branche dans une requête de tirage​

Voir la section sur les requêtes de tirage dans le guide sur les contributions simples.