Comment contribuer à la traduction de l'osu!wiki francophone?
Introduction
Bien le bonjour! Comme vous le savez probablement, le site Internet d'osu! contient un wiki qui permet d'obtenir plein d'informations à propos de "l'osu-sphere".
Cependant, le processus de contribution n'étant pas du tout évident pour quelqu'un n'ayant aucune connaissance sur GitHub, beaucoup de gens n'ont pas le courage de participer, ou certains ne sont même pas au courant que cela est possible.
C'est pourquoi aujourd'hui je vous fais un tutoriel (merci infiniment à fajar13k pour l'aide) afin de pouvoir comprendre le fonctionnement du processus nécessaire à la contribution, en espérant que ce tutoriel en motivera quelques uns à me rejoindre.
La durée de ce processus ne devrait pas durer plus de 30 minutes.
--------------------------------
Pré-requis
Avant de commencer, il est impératif d'avoir un compte sur GitHub! Si vous n'en avez pas, je vous invite à le créer ici.
Une fois ceci fait, je vous invite à installer:
- Visual Studio Code, un éditeur de code sur lequel vous allez pouvoir y écrire la traduction, ainsi que la modifier.
- GitHub Desktop, le programme qui vous permettra de faire le lien entre votre éditeur de code et le projet osu-wiki.
Cliquez sur Fork qui se trouve en haut à droite de votre page web. Pour faire bref, le fait de Fork le projet vous permettra de copier le projet entier sur votre ordinateur afin de pouvoir l’éditer sans affecter le projet original.
--------------------------------
Mise en place de GitHub Desktop
Bien, maintenant que tout ceci est fait, allumez le logiciel GitHub Desktop puis connectez vous avec vos identifiants GitHub. Une fois connecté, vous allez atterrir sur cette fenêtre. Vérifiez que votre projet qui est censé s'appeler votre nom GitHub/osu-wiki soit bien sélectionné, puis cliquez sur Clone votre nom GitHub/osu-wiki.
Normalement la procédure est censé prendre un peu de temps, c'est normal, le projet entier est en train de se télécharger.
Une fois terminé, cette fenêtre est censée apparaitre. Cela veut dire que tout le projet a bien été copié et que vous êtes prêt à vous mettre au travail.
Maintenant que les fichiers ont été copiés, je vais vous parler de quelque chose qui sera très important par la suite: le branch.
Mais Pachi, qu'est-ce qu'une branch?! Pas de panique, voyez les branch comme des sauvegardes. De base, la branch sélectionnée sur GitHub Desktop est la branch master.
Celle-ci sera votre sauvegarde principale, donc dans le cadre de la traduction, je ne vous conseille absolument pas de travailler dessus.
C'est donc pour cela que l'on va créer une nouvelle branch. Il est important de créer une branch a chaque nouvelle page traduite, vous comprendrez par la suite pourquoi.
Rendez-vous sur la barre d'outils en haut de la fenêtre, dans l'onglet Branch, puis cliquez sur New Branch.... Pour le nom de votre branch, entrez le de cette manière: nom-de-la-page-traduite-fr-patch. (Par exemple, si je souhaite traduire la page Welcome du wiki, le nom de ma branch sera welcome-fr-patch.)
--------------------------------
Mise en place de Visual Studio Code
Maintenant que GitHub Desktop est configuré (laissez le allumé), nous allons passer à Virtual Studio Code. Allumez Virtual Studio Code, puis cliquez sur l’icône Extensions, elle est censée ressembler a ceci.
Vous allez devoir rechercher grâce à la barre de recherche, deux extensions qui sont GitLens (par Eric Amodio) & Markdown All In One (par Yu Zhang). Installez ces deux extensions.
Bien, nous y sommes presque! Ne lâchez pas!
Rendez vous dans l'onglet File sur la barre d'outils en haut de votre fenêtre, puis Open Folder. Sélectionnez la destination dans lequel vous avez cloné le projet osu-wiki précédemment à partir de GitHub Desktop.
Normalement si tout s'est bien passé, votre fenêtre doit plus ou moins ressembler à celle-ci. Si c'est le cas, alors c'est génial, vous voila enfin prêt pour devenir un traducteur aguerri!
--------------------------------
Processus de traduction
Maintenant que la préparation est terminée, choisissez la page du wiki que vous souhaitez traduire, en faisant bien attention a ne pas prendre une page déjà traduite en français. La plupart de la traduction se déroule sur Virtual Studio Code.
Pour l'exemple, je vais prendre la page Accuracy. Je déroule donc le dossier wiki, puis le sous-dossier Accuracy, comme ceci. Une fois que le sous-dossier Accuracy est sélectionné, vous pouvez créer un New File. Une fois ceci fait, nommez votre fichier fr.md, c'est très important.
Maintenant il ne vous reste plus qu'à traduire le fichier en.md sur fr.md.
Un petit conseil que je peux vous donner, c'est de copier le contenu du fichier en.md sur le fichier fr.md, pour éviter de devoir changer de page à chaque phrase, et en plus de ça, vous n'aurez pas toute la mise en page assez fastidieuse a faire.
Lorsque vous aurez des lignes a traduire comme celles-ci, traduisez simplement ce qui est compris dans les crochets et non entre les parenthèses, car celles-ci servent a introduire les liens, donc il est inutile de les traduire et en plus de ça elles pourraient corrompre le lien.
Si vous voulez traduire avec un retour de ce que vous écrivez, faites CTRL+K puis appuyez sur V ensuite et comme par magie une deuxième fenêtre s'ouvrira. Ceci est totalement optionnel bien entendu.
--------------------------------
Partager votre traduction
Super, vous y êtes arrivés! Maintenant il ne vous reste plus qu'a partager votre traduction afin qu'elle soit vérifiée puis mise en ligne.
Retournez donc GitHub Desktop, normalement votre fenêtre est censée ressembler plus ou moins à ça. Soyez sûrs que le fichier que vous avez traduit soit bien sélectionné, puis rendez-vous sur la partie en bas a gauche de votre écran.
Dans la première ligne, entrez le titre de votre contribution de cette manière: [FR] page traduite, puis dans la deuxième, entrez une description de votre contribution, dans le cadre d'une traduction, entrez quelque chose comme: French translation of osu! wiki - Welcome Page.
Vérifiez que tout soit bien correct, puis cliquez sur le bouton bleu Commit to nom de votre branch. Normalement, un processus automatique va se lancer, puis une fois que celui-ci est terminé, cliquez sur le bouton Publish branch.
Aprés avoir effectué cette étape, les fichiers seront donc envoyés sur votre repository, mais nous ce que l'on souhaite, c'est le partager sur le repository de ppy afin qu'il puisse être vérifié puis publié. Rendez-vous donc sur le projet GitHub osu-wiki de ppy, vous serez donc censés avoir ceci.
Cliquez sur le bouton vert Compare & pull request, qui vous redirigera vers une page comme celle-ci. Vérifiez que tout est bien ok, puis appuyez sur le bouton vert Create pull request.
Pour vous expliquer un peu ce qu'il se passe, le site va comparer votre projet, celui que vous avez fork, avec celui de ppy, pour voir ce qui a été changé. Et ensuite, la pull request sert à informer ppy que vous avez effectués des changements et c'est grâce à ça que votre fichier pourra être vérifié pour corriger les fautes si il y en a, puis être validé ensuite et intégré au wiki!
--------------------------------
Petit plus sur Visual Studio Code (non nécessaire pour la traduction)
Il existe des extensions afin de pouvoir vérifier l'orthographe. Suivez-le petit tutoriel ci-dessous, qui est proposé par Doryan:
Le nom de des extensions permettant de vérifier l'orthographe sont Code Spell Checker et French - Code Spell Checker de Street Side Software.
Après l'avoir installé, vous devez le configurer pour qu'il vous affiche les fautes en Français, rien de plus simple :
- Sur la ligne bleu en bas, vous avez "markdown | fr.md" par exemple, cliquez dessus. Vous allez tomber sur la configuration de l'extension.
- Allez sur l'onglet "User" et cocher "French" et "English", et faites la même chose sur l'onglet "Workspace".
- Quand cela est fait, aller sur votre fichier, toutes les fautes seront soulignées en bleu.
Pour ajouter un mot dans le dictionnaire, faites la même chose que pour corriger un mot, mais sélectionnez "add <mot à corriger> in dictionnaire user, ou workspace"
--------------------------------
Merci à vous d'avoir lu ce tutoriel, le but de celui-ci est de pouvoir regrouper une petite communauté de traducteurs afin de pouvoir compléter la traduction du wiki de manière efficace.
N'hésitez pas a rejoindre le discord officiel francophone, sur lequel nous disposons d'un channel #traduction!
Si vous avez des questions ou bien me signaler un soucis de screenshot qui ne fonctionne pas, n'hésitez surtout pas a me contacter par forum PM, sur le jeu ou bien par Discord. (Pachiru#1249 ou Imakuri#2307)
Bonne journée a vous!
