wiki

GitHub Desktop

Cet article est la suite de la page principale et suppose que vous utilisez GitHub Desktop. **Même si vous travaillez localement, vous aurez toujours besoin d'accéder à GitHub pour créer des pull requests afin de réaliser vos changements.

Installation de GitHub Desktop

  1. Installez GitHub Desktop si vous ne l'avez pas déjà installé.
  2. Une fois l'installation terminée, GitHub Desktop vous invite à vous connecter, cliquez sur Sign in to GitHub.com.
  3. Répondez aux questions au fur et à mesure qu'elles apparaissent.
  4. Passez à Clonage.

Clonage

  1. Cliquez sur Clone a repository..

  2. Cela affichera une liste de vos dépôts ; sélectionnez le dépôt osu-wiki.

  3. Sélectionnez l'emplacement du clone. L'endroit où vous clonez le dépôt n'a pas d'importance, souvenez-vous simplement de l'endroit où vous l'avez cloné.

  4. Cliquez sur Clone. Cela peut prendre un certain temps en fonction de votre environnement réseau.

  5. Continuer vers Branches.

Branches

Bien que les branches soient techniquement facultatives, elles sont fortement recommandées pour plusieurs raisons. Pour n'en citer que quelques-unes :

  • Les branches isolent les différentes modifications logiques les unes des autres : vous pouvez travailler sur plusieurs articles et les faire réviser et fusionner séparément.
  • Lorsque vos modifications sont en dehors de la branche master, vous pouvez les synchroniser en toute sécurité sans conflits de fusion.
  1. Cliquez sur le menu déroulant Current branch situé en haut du menu.

  2. Saisissez le nom de la branche. Il est suggéré d'utiliser le résumé de vos modifications comme nom de branche. Par exemple, si vous modifiez l'article Forums, la branche s'appellera update-forums-FR.

  3. Continuer vers Édition.

Édition

  1. Dans le dossier dans lequel vous avez cloné le dépôt, naviguez jusqu'au fichier que vous voulez modifier. Les articles sont organisés par les noms de dossiers qui sont les noms d'articles et les fichiers .md qui sont les locales.
  2. Une fois que vous avez trouvé le bon fichier, ouvrez-le en utilisant votre éditeur de texte préféré.
  3. Vous pouvez maintenant apporter vos modifications. Lorsque vous apportez des modifications, suivez les Critères de mise en forme des articles aussi fidèlement que possible.
  4. Continuer vers Commits et pushs.

Déplacement de fichiers existants

  1. Utilisez l'Explorateur Windows pour déplacer les fichiers.
  2. Continuer vers Commits et pushs.

Création de nouveaux fichiers

Attention : Si vous comptez créer des fichiers d'articles à l'aide de l'Explorateur Windows, assurez-vous que l'option Masquer les extensions des fichiers dont le type est connu est désactivée. Voir Toujours afficher les extensions des fichiers pour les instructions.

  1. Utilisez l'Explorateur Windows, votre éditeur d'images préféré et/ou votre éditeur de texte préféré pour créer de nouveaux fichiers. Si vous créez de nouveaux articles ou de nouvelles traductions, renommez le fichier pour respecter les Locales dans les critères de mise en forme des articles.
  2. Continuer vers Commits et pushs.

Suppression de fichiers

  1. Utilisez l'Explorateur Windows pour supprimer des fichiers.
  2. Continuer vers Commits et pushs.

Commits et pushs

  1. Retournez sur le bureau GitHub. Il devrait ressembler à ceci :

Le nombre de fichiers peut varier.

  1. Par défaut, GitHub Desktop sélectionne automatiquement toutes vos modifications.
  2. Il est préférable de séparer chaque "grosse" action en un seul commit.

Par exemple, comme illustré ci-dessus, pippi a ajouté un fichier image, modifié le fichier en.md pour ajouter un titre et un lien vers l'image, et marqué les traductions comme obsolètes. A partir de cela, nous pouvons avoir deux commits, un pour les changements qui ont affecté le fichier en.md, et un pour marquer les traductions comme obsolètes.

  1. Sélectionnez les fichiers qui vont être placés dans le commit.
  2. Entrez le résumé du commit. Il est limité à 72 caractères et doit être en anglais.
  3. Saisissez la description. Celle-ci est facultative, n'est pas limitée en nombre de caractères et peut être rédigée dans n'importe quelle langue.

Premier commit

  1. Cliquez sur le bouton bleu Commit to et, le cas échéant, recommencez depuis l'étape 4 pour faire les autres commits que vous voulez faire.

Deuxième commit

  1. Une fois que vous avez fini de faire vos commits, cliquez sur le bouton Publish branch en haut.

  1. Continuez vers Finition pour le dernier élément d'information concernant votre pull request et les changements.