Bonjour/Bonsoir

Aujourd'hui je voudrait aborder avec vous un projet qui tombe dans l'oubli, mais qui me semble important de connaître : la traduction du osu! wiki en français.

Mais avant toute chose, commençons par évoquer l'historique de ce projet :

1. Le osu! wiki à été créer en 2011, hébergé à l'époque sur MediaWiki.
2. La naissance du projet de traduction en français à débuté avec ce post de Fight69, qui date de 2012.
3. En 2016, le osu! wiki à été migré sur GitHub, une plateforme de développement assez connu qui améliore considérablement la collaboration.
4. En 2019, Pachiru décide de créer ce post afin d'inciter des personnes à l'aider dans la traduction du wiki, en y expliquant comment faire, car cette nouvelle plateforme n'est pas évidente a prendre en main.

C'est à partir de ce tuto que quelques mois plus tard, j'ai rejoint ce projet pour aider dans la traduction du wiki.
Honnêtement, j'ai contribuer à ce projet pour apprendre un peut à m'en sortir en anglais, car j'avais du mal. Je traduisais donc avec Google Traduction. Ça allait beaucoup plus vite, mais à l'époque je faisais pas du bon travail, je l'avoue. Je me relisais pas, et faisais de grosses fautes.

Le projet commençant à ralentir après plusieurs mois, et comme les gens était de plus en plus hostile envers moi, j'ai décider de partir.
J'ai tenté plusieurs fois de revenir, tout d'abord pour montrer que j'avais fait des efforts, mais également pour le faire revivre, mais cela n'a pas eu de succès. Le projet était déjà presque éteint. Je commençais à ne plus être motivé de m'obstiner à faire revivre un projet mort.

Mais aujourd'hui, après 1 an, je souhaite y aller à fond et le faire revivre. Mais pour cela, il faut le faire correctement, en commençant par refaire le tuto qui est obsolète et qui manque de détails.

Il est important d'avoir des contributeurs à ce projet, car osu!(lazer) va bientôt sortir, et il faudra du monde pour tout traduire !

Je compte donc sur vous ! Si vous voulez contribuer à la traduction du osu! wiki, pour vous, mais également pour les autres, vous êtes les bienvenue !


Cela étant dit, commençons tout d'abord par nous poser une question : qu'est-ce le osu! wiki ? C'est très simple. C'est la base de connaissance du jeu, qui vous permet de savoir presque tout sur osu! : son histoire, son fonctionnement interne, les différents modes de jeu, leurs mécanismes, comment fonctionne le système de classement, et pleins d'autres choses.

Le wiki est écrit en langage Markdown, c'est un langage texte simple qui permet d'enrichir facilement un texte sans avoir des pages remplies de code (le HTLM en est un exemple).


La langue de base du wiki est l'anglais, avec un choix de 31 langues différentes pour le lire.
Pour avoir la page dans la langue souhaité, il faut la traduire. Ce sont les personnes natif de cette langue (comme vous !) qui traduise les pages

Comme évoqué plus tôt, pour proposer les traductions des articles, il faut utiliser la plateforme GitHub. Pour pouvoir y arriver, il y a deux possibilité, selon vos préférences :

1. Vous pouvez utiliser GitHub.dev qui est un éditeur de texte avec une intégration de GitHub pour pouvoir tout faire sans rien télécharger sur votre ordinateur.
2. Vous pouvez également télécharger sur votre ordinateur GitHub Desktop pour gérer la partie GitHub, couplé avec Visual Studio Code et quelques extensions pour y intégrer GitHub et éditer les articles.

Il existe surement d'autres logiciels et façon de faire, mais j'ai décider d'évoquer ces deux la, qui sont plutôt simple à mettre en place.

Je vais vous détailler la marche à suivre pour vous permettre de contribuer en toute facilité.

1. La solution sans installation de logiciels
2. La solution avec installation de logiciels
3. Mettre en ligne votre travail
4. Le processus de review d'un Pull Request
5. Résoudre un problème avec les contrôles automatisés
6. Résoudre un conflit
7. Conclusion

Cette solution est idéale pour ceux qui ne souhaitent rien installer. Il existe un article du wiki qui explique la marche à suivre, mais je vais vous détailler comment vous y prendre. Vous pouvez vous appuyer sur ce dernier si vous le souhaitez.


Pour commencer, vous devez créer un compte sur GitHub via ce lien, sinon il ne vous sera pas possible de contribuer.
Une fois cela fait, nous allons aller sur le dépôt (repository) du wiki.


Le repository du wiki

Une fois arrivé ici, vous allez cliquer sur pour créer un fork du repository, qui vous permettra de proposer des traductions sans modifier le repository directement.


La page de votre fork (copie du repository)

Une fois votre fork créer, on aura déjà fait 50% du travail. Tout ce qui reste à faire et la mise en place de GitHub.dev.


Pour ce faire, retourner sur le repository du wiki.
Ensuite, vous allez, sur la barre d'adresse internet en haut modifier le lien github.com en github.dev pour accéder à l'éditeur intégré à GitHub.


La page principal de GitHub.dev

Comme j'ai déjà ouvert GitHub.dev, je tombe directement sur cette page. Si c'est la première fois, vous aller devoir configurer votre expérience, et éventuellement synchroniser votre compte GitHub à GitHub.dev pour sauvegarder vos paramètres si vous le souhaitez.


Maintenant que les logiciels sont prêt, on peut enfin rentrer dans le vif du sujet : la traduction.

Avant toute chose, il faut savoir qu'est ce qui doit être traduit ou non. Pour cela, nous utilisons le site osu-wiki FR status, qui à été créer par un maintainer (des modérateurs du repository), cl8n.


La page de osu-wiki status

Sur cette page, vous trouverez toutes les pages qui sont soit traduite mais non à jour, soit non traduite.
Les catégories Outdated translations (outdated in English), Missing articles (outdated in English), Missing stubs (outdated in English) (tout en bas de la page) ne sont pas à traduire, car l'article en anglais n'est pas à jour.
Tout ce qui est présent sur les autres catégories sont à faire.

Afin d'éviter que tout le monde traduise la même page, avec d'autres membres, nous avons créer un Trello qui permet de savoir ce qui est en cours de traduction, ce qui est en cours de vérification sur GitHub, et un petit historique de ce qui à été fait.


La page du Trello

Ici, pas besoin de compte pour visualiser le contenu. Il faudra juste nous prévenir via notre discord sur quoi vous travailler, pour que l'on puissent l'ajouter.

Une fois votre page choisi, et que cette dernière n'est pas déjà en cours de traduction ou déjà traduite, et que vous nous avez prévenu, on va pouvoir commencer.


Une petite astuce : avant de commencer à traduire, je vous conseil de créer une branche (ou branch) afin de mieux vous organiser.
Voyez les branch comme un morceau de votre fork que vous allez pouvoir modifier sans affecter votre fork. Cela est particulièrement utile quand vous souhaitez traduire plusieurs articles différents, car si vous n'en avez pas créer, l'article qui est déjà traduit va ce retrouver dans la demande d'un autre article, ce qui engendrera un conflit. Quoi qu'il arrive, les maintainer vous en feront la remarque.

Pour créer votre branch, appuyer sur la touche F1 de votre clavier pour faire apparaître le menu Palette de commandes, et tapez créer une branch, et appuyer sur entrée.

Ensuite, il faut renseigner le nom de la future branch. Selon l'article que vous allez traduire, je vous conseille de mettre le chemin pour accéder au fichier, et y rajouter la langue du fichier.
Pour mieux comprendre, je vais vous explique un cas concret : je vais traduire la page Beat Snapping, dont son chemin d'accès sur le repository est wiki/Beatmapping/Beat_snapping/fr.md, je vais donc appeler ma branch beatmapping-beat-snapping-fr (il ne faut pas d'espace dans le nom, donc j'ajoute des "-" à la place des espaces).


Maintenant que votre branch est créer, vous pouvez commencer à traduire.
Pour trouver l'article qui vous intéresse, vous pouvez le chercher via l'arborescence, ou via la palette de commande en utilisation la combinaison de touche Ctrl + P. Taper ensuite le nom de l'article, ou son chemin d'accès.


Recherche d'un article

Pour que la traduction soit conforme avec les règles de style du wiki (appelé content parity), il faut que la traduction ne modifie pas le style de l'article, ou encore que son contenu ne diffère pas de son équivalent en anglais.

C'est pour cela qu'un glossaire est présent sur le Trello pour déterminer ce qui doit être traduit ou non.


L'article Beat Snapping en anglais sur GitHub.dev

Pour vous expliquer la marche à suivre, je vais me baser sur l'article Beat Snapping en anglais :

1. On peut voir à gauche dans l’arborescence du fichier qu'il existe déjà une traduction en français et en indonésien. Ici il faudra donc mettre à jour la traduction.
2. S'il n'y avait pas de fichier fr.md, il aurait fallu le créer, et copier le contenu du fichier en.md dans le nouveau fichier pour faciliter la traduction et éviter des erreurs de mises en page.
3. Sur l'article, on trouve plusieurs choses :
4. ce sont les tags de l'article, qui permettent de le retrouver via la recherche sur le site d'osu!. Il ne faut pas traduire le "tags:", mais on peut traduire les tags en dessous, tout en gardant ceux en anglais.
5. ce sont des liens qui renvoient vers des articles sur le wiki. Il ne faut pas traduire ce qui ce trouve entre parenthèse, mais entre crochets oui.
6. ce sont des liens qui renvoient vers des articles qui ce trouve en dehors du wiki. Ici, c'est un lien Wikipédia. Si la page en français existe, on doit la modifier. Sinon, on laisse le lien en anglais.
7. ce sont des dates au format américain (aaaa-mm-jj). Il faut les convertir dans notre format (jj/mm/aaaa) pour plus de clarté. Nous verrons plus tard des extensions qui nous permettrons de faire cela plus facilement.

Il y a encore des cas spéciaux qui sont détaillé dans le glossaire, je ne vais pas tout détaillé, pour ne pas vous embrouiller.


Une fois l'article traduit, il faut maintenant l'envoyer sur GitHub.
Pour ce faire, aller dans le menu . Le nombre à côté montre le nombre de fichiers qui à été modifié.


Menu source control

Ici, on va rentrer le commentaire ce que l'on à fait (aussi appelé commit). Dans mon cas, comme j'ai ajouter un article au wiki, je vais mettre comme commentaire [FR] Add `Centurions`.
Une fois cela fait, cliquer sur pour l'envoyer sur GitHub.

Maintenant, vous pouvez passer à la suite en allant voir le chapitre Mettre en ligne votre travail


Pour vous aider à aller plus vite dans la traduction, je vous conseille quelques extensions :

1. Markdown All in One de Yu Zhang > Cette extension vous permet de faire apparaître la syntaxe Markdown dans un fichier Markdown (finissant par ".md")
2. GitLens — Git supercharged de GitKraken > Cette extension vous permet d'inclure une version amélioré de GitHub quand vous êtes lié à un repository. Grâce a cette extension, vous aurez accès au repository de l'osu! wiki sans quitter GitHub.dev. Il intègre également des fonctions pratiques, comme l'historique des modifications ligne par ligne.
3. Date Conversion de HayatoKudo > Cette extension vous permet de convertir une date américaine (yyyy-mm-dd) dans le format français (jj/mm/aaaa). Cela est pratique dans les articles avec beaucoup de dates à convertir.
4. Code Spell Checker et French - Code Spell Checker de Street Side Software > Cette extension vous permet d'intégrer un correcteur orthographique sur de nombreux types de fichiers, dont le Markdown.

Pour ajouter l'extension, vous n'avez qu'à cliquer sur le nom dans la liste, ou cliquer sur et chercher le nom directement.

Libre à vous de les utiliser ou non, elle sont facultative, même si les deux premières sont fortement recommandé pour ne pas faire d'erreurs de formatage Markdown.

À titre personnel, je conseille cette solution, car cela permet plus de liberté, et également cela est plus simple d'utilisation. Il existe un article du wiki qui explique la marche à suivre, mais je vais vous détailler comment vous y prendre. Vous pouvez vous appuyer sur ce dernier si vous le souhaitez.


Pour commencer, vous devez créer un compte sur GitHub via ce lien, sinon il ne vous sera pas possible de contribuer.
Une fois cela fait, nous allons aller sur le dépôt (repository) du wiki.


Le repository du wiki

Une fois arrivé ici, vous allez cliquer sur pour créer un fork du repository, qui vous permettra de proposer des traductions sans modifier le repository directement.


La page de votre fork (copie du repository)

Une fois votre fork créer, on à terminé 50% du travail. Tout ce qui reste à faire est d'installer GitHub Desktop et Visual Studio Code.


Nous allons maintenant installer GitHub Desktop. Mais d'abord, à quoi cela va nous servir ?

GitHub Desktop vous servira afin de réaliser toutes les opérations nécessaire : gérer votre fork, créer des branch (des sauvegardes), des commits (des messages pour savoir ce que vous avait fait), et mettre en ligne vos Pull Requests (la demande final). Pas de panique, tout va bien ce passer !

Tout d'abord, allez sur le site de GitHub Desktop, et cliquez sur

Une fois le téléchargement terminé, aller dans votre dossier de téléchargements, et lancer le fichier nommé GitHubDesktopSetup-x64 (ce sera peut être x32 chez vous, mais c'est la même chose).
Laissez vous guider lors de l'installation.


La page d'ajout d'un repository

Une fois téléchargé, vous allez devoir vous connecter avec votre compte GitHub.

Une fois cela fait, vous aller arriver sur cette page, vous avez plusieurs choix qui vous sont proposés.
Comme nous avons déjà créer le fork du repository, il ne reste plus qu'à sélectionner le fork dans la liste à droite. Pour moi, ce sera
Cliquer dessus, et valider avec


Fenêtre de configuration du clonage

Une fenêtre va s'ouvrir. Vous n'avez rien à changer, à part si vous souhaitez changer le dossier d'installation du fork.
Si tout est bon pour vous, cliquez sur

Désormais, le fork du repository de l'osu! wiki est en cours de téléchargement sur votre ordinateur. L'opération peut prendre du temps, alors soyez patient.


Fenêtre vous demandant la façon d'utiliser votre fork

Une fois terminé, on va vous demander une dernière petite chose : comment comptez vous utiliser le fork ?
Rien de plus simple, laisser l'option To contribute to the parent project, et cliquer sur


Page principal de GitHub Desktop

Voilà ! pour le moment nous en avons fini avec GitHub Desktop. N'hésitez pas à explorer les options pour personnaliser l'application à votre goût.


Maintenant que GitHub Desktop est installé et configuré correctement, on va pouvoir s'occuper de Visual Studio Code.

Visual Studio Code est un éditeur de code simplifié, qui permet de modifier pas mal de langages de programmation. Je le trouve simple d'utilisation et très complet, avec beaucoup de personnalisation.

Avant toute chose, nous allons l'installer. Pour ce faire, aller sur le site de Visual Studio Code, et cliquez sur

Une fois téléchargé, cliquer sur le fichier VSCodeUserSetup-x64-1.81.1.exe dans vos téléchargements (pareil, si c'est x32 chez vous, c'est la même chose. La version peut différer également, mais ce n'est pas grave, cela ne changera rien).
Laissez vous guider lors de l'installation.


Fenêtre d’accueil de Visual Studio Code

Une fois l'installation terminé, vous allez arriver sur la page principale de Visual Studio Code. Comme je l'ai déjà ouvert, je tombe directement sur cette page. Si c'est la première fois, vous aller devoir configurer votre expérience, et éventuellement synchroniser votre compte GitHub à Visual Studio Code pour sauvegarder vos paramètres.

À partir de maintenant, le logiciel est théoriquement prêt. Cependant, afin d'améliorer la productivité, nous allons ajouter des extensions.
Pour ajouter une extension, vous n'avez qu'à cliquer sur le nom dans la liste, ou cliquer sur et chercher le nom directement.

Voici les extensions que je vous conseille :

1. Markdown All in One de Yu Zhang > Cette extension vous permet de faire apparaître la syntaxe Markdown dans un fichier Markdown (finissant par ".md")
2. GitLens — Git supercharged de GitKraken > Cette extension vous permet d'inclure une version amélioré de GitHub quand vous êtes lié à un repository. Grâce a cette extension, vous aurez accès au repository de l'osu! wiki sans quitter Visual Studio Code. Il intègre également des fonctions pratiques, comme l'historique des modifications ligne par ligne.
3. Date Conversion de HayatoKudo > Cette extension vous permet de convertir une date américaine (yyyy-mm-dd) dans le format français (jj/mm/aaaa). Cela est pratique dans les articles avec beaucoup de dates à convertir.
4. Code Spell Checker et French - Code Spell Checker de Street Side Software > Cette extension vous permet d'intégrer un correcteur orthographique sur de nombreux types de fichiers, dont le Markdown.

Libre à vous de les utiliser ou non, elle sont facultative, même si les deux premières sont fortement recommandé pour ne pas faire d'erreurs de formatage Markdown.


Maintenant que les logiciels sont prêt, on peut enfin rentrer dans le vif du sujet : la traduction.

Avant toute chose, il faut savoir qu'est ce qui doit être traduit ou non. Pour cela, nous utilisons le site osu-wiki FR status, qui à été créer par un maintainer (des modérateurs du repository), cl8n.


La page de osu-wiki status

Sur cette page, vous trouverez toutes les pages qui sont soit traduite mais non à jour, soit non traduite.
Les catégories Outdated translations (outdated in English), Missing articles (outdated in English), Missing stubs (outdated in English) (tout en bas de la page) ne sont pas à traduire, car l'article en anglais n'est pas à jour.
Tout ce qui est présent sur les autres catégories sont à faire.

Afin d'éviter que tout le monde traduise la même page, avec d'autres membres, nous avons créer un Trello qui permet de savoir ce qui est en cours de traduction, ce qui est en cours de vérification sur GitHub, et un petit historique de ce qui à été fait.


La page du Trello

Ici, pas besoin de compte pour visualiser le contenu. Il faudra juste nous prévenir via notre discord sur quoi vous travailler, pour que l'on puissent l'ajouter.

Une fois votre page choisi, et que cette dernière n'est pas déjà en cours de traduction ou déjà traduite, et que vous nous avez prévenu, on va pouvoir commencer.


Une petite astuce : avant de commencer à traduire, je vous conseil de créer une branche (ou branch) afin de mieux vous organiser.
Voyez les branch comme un morceau de votre fork que vous allez pouvoir modifier sans affecter votre fork. Cela est particulièrement utile quand vous souhaitez traduire plusieurs articles différents, car si vous n'en avez pas créer, l'article qui est déjà traduit va ce retrouver dans la demande d'un autre article, ce qui engendrera un conflit. Quoi qu'il arrive, les maintainer vous en feront la remarque.

Pour créer votre branch, retourner sur GitHub Desktop, et cliquer sur , ensuite sur


Fenêtre de création de la branch

Ensuite, il faut renseigner le nom de la future branch. Selon l'article que vous allez traduire, je vous conseille de mettre le chemin pour accéder au fichier, et y rajouter la langue du fichier.
Pour mieux comprendre, je vais vous explique un cas concret : je vais traduire la page Beat Snapping, dont son chemin d'accès sur le repository est wiki/Beatmapping/Beat_snapping/fr.md, je vais donc appeler ma branch beatmapping-beat-snapping-fr (il ne faut pas d'espace dans le nom, donc j'ajoute des "-" à la place des espaces).

Une fois la branch créer, cliquer sur


Maintenant que votre branch est créer, vous pouvez commencer à traduire.
Pour trouver l'article qui vous intéresse, vous pouvez le chercher via l'arborescence, ou via la palette de commande en utilisation la combinaison de touche Ctrl + P. Taper ensuite le nom de l'article, ou son chemin d'accès.


Recherche d'un article

Pour que la traduction soit conforme avec les règles de style du wiki (appelé content parity), il faut que la traduction ne modifie pas le style de l'article, ou encore que son contenu ne diffère pas de son équivalent en anglais.

C'est pour cela qu'un glossaire est présent sur le Trello pour déterminer ce qui doit être traduit ou non.


L'article Beat Snapping en anglais sur GitHub.dev

Pour vous expliquer la marche à suivre, je vais me baser sur l'article Beat Snapping en anglais :

1. On peut voir à gauche dans l’arborescence du fichier qu'il existe déjà une traduction en français et en indonésien. Ici il faudra donc mettre à jour la traduction.
2. S'il n'y avait pas de fichier fr.md, il aurait fallu le créer, et copier le contenu du fichier en.md dans le nouveau fichier pour faciliter la traduction et éviter des erreurs de mises en page.
3. Sur l'article, on trouve plusieurs choses :
4. ce sont les tags de l'article, qui permettent de le retrouver via la recherche sur le site d'osu!. Il ne faut pas traduire le "tags:", mais on peut traduire les tags en dessous, tout en gardant ceux en anglais.
5. ce sont des liens qui renvoient vers des articles sur le wiki. Il ne faut pas traduire ce qui ce trouve entre parenthèse, mais entre crochets oui.
6. ce sont des liens qui renvoient vers des articles qui ce trouve en dehors du wiki. Ici, c'est un lien Wikipédia. Si la page en français existe, on doit la modifier. Sinon, on laisse le lien en anglais.
7. ce sont des dates au format américain (aaaa-mm-jj). Il faut les convertir dans notre format (jj/mm/aaaa) pour plus de clarté. Nous verrons plus tard des extensions qui nous permettrons de faire cela plus facilement.

Il y a encore des cas spéciaux qui sont détaillé dans le glossaire, je ne vais pas tout détaillé, pour ne pas vous embrouiller.


Une fois l'article traduit, il faut maintenant l'envoyer sur GitHub pour ensuite le mettre en ligne.


Fenêtre GitHub Desktop modifié

Pour ce faire, retourner sur GitHub Desktop. Vous verrez que la fenêtre à été modifier, et remplacer par les modifications effectué sur le fichier traduit.


Fenêtre de création d'un commit

Ici, on va rentrer le commentaire ce que l'on à fait (aussi appelé commit). Dans mon cas, comme j'ai modifier un article au wiki, je vais mettre comme commentaire [FR] Update `Beat Snapping`.
Une fois cela fait, cliquer sur pour sauvegarder le commit sur la branch.

Enfin, pour l'envoyer sur GitHub, cliquer sur

Maintenant, vous pouvez passer à la suite en allant voir le chapitre Mettre en ligne votre travail

Encore un petit effort. Il ne reste plus qu'à mettre en ligne votre travail. Pour cela, retourner sur le repository sur GitHub, vous aurez un nouveau bouton qui va apparaître, tout en haut de la page :


Création de la Pull Request

Cela veut dire que votre commit à bien été pris en compte par GitHub, et qu'il faut désormais faire une demande (appelé Pull Request ou PR en abrégée) pour que les autres français puissent l'examiner.
Pour ce faire, cliquer sur


Page de création de la Pull Request

Sur cette page, vous allez pouvoir modifier le titre, la description, la liste des commits présent dans la branch, et voir les modifications réalisé sur le fichier.

La description est déjà prérempli. Ce qui ce trouve entre "<!--" n'est pas visible dans le message final.

Avant de poster votre Pull Request, vous pouvez aller voir les deux articles mentionné (le guide de contribution, chapitre les checks à réaliser et le guide de contribution, chapitre les reviews que nous verrons un peut plus tard). Je vous conseille de le lire si c'est votre première Pull Request. Mais n'ayez crainte, on vous notifiera ce qui ne va pas, et comment s'y prendre la prochaine fois.

Pour le titre, je vous conseille de suivre le nom du commit. Dans mon cas, je vais mettre [FR] Add `People/Centurion`. Pour la description, vous pouvez laisser comme tel, ou retirer la partie qui n'est pas visible et laisser les "self-check" comme j'ai tendance à le faire.

Une fois que tout est bon, vous n'avez plus qu'à cliquer sur


La PR posté et en attente d'être examiné

Maintenant que la Pull Request est en ligne, il ne reste plus qu'à attendre qu'elle soit examiné par d'autres contributeurs (c'est ce qu'on appelle le processus de review).


Message automatique si première Pull Request posté

Si c'est votre première Pull Request, vous aurez un message automatique d'un bot qui vous explique quelques consignes et explication sur certains aspects du review, que nous allons voir.

Le review (révision) d'un Pull Request est une partie très importante du processus. Sans cette étape, il est impossible de voir un jour la traduction ajouté sur l'osu! wiki.

Pour pouvoir faire un review, aller tout d'abord dans la liste des Pull Requests en cours grâce à sur GitHub, ou en cliquant sur le lien du bot Librarian sur notre discord


Lien vers la Pull Request, via le bot Librarian sur le Discord


Ce a quoi ressemble un Pull Request

La Pull Request ressemble à ça.
Elle est composé de la discussion en haut, et d'une autre partie en bas.
La partie du bas sert à savoir si la Pull Request est prête à être mergé (ou fusionné, ou encore mise en ligne) sur le wiki, d'un point de vue technique.


Les contrôles automatisés

Ce sont les contrôles automatisés qui sont réaliser sur le contenu de la Pull Request. Si des erreurs courantes sont signalé, une croix rouge est présente. Si tout va bien, une coche verte sera présente.

Si vous avez une croix rouge, vous pouvez vous rendre dans le chapitre Résoudre un problème avec les contrôles automatisés afin de savoir comment résoudre le problème.


Le review est destiné à ceux qui n'ont pas mise en ligne la Pull Request. Ce sont ces personnes qui permettront de valider si le travail réalisé est correcte ou non.

Pour faire un review, commencez tout d'abord par choisir la Pull Request qui vous intéresse, ensuite, cliquez sur


Page des fichiers modifiés en attente de review

Cette page est l'endroit ou les personnes chargé du review passeront le plus clair de leurs temps.
Ici, vous trouverez tout les fichiers qui ont été traduit (ou modifié). Ce qui est en vert à été ajouter par rapport à l'original. Si vous voyez du rouge, ce sont des éléments qui ont été supprimé.

À partir de maintenant, il vous suffit de lire l'article. Si vous trouvez des erreurs ou que vous avez un doute sur quelque chose, passez votre souris sur la gauche (ou ce trouve les "+" dans l'exemple) pour faire apparaître . Cliquez dessus. Vous pouvez aussi faire glisser pour sélectionner plusieurs lignes.


Fenêtre de proposition d'une modification

Une fois la fenêtre de commentaire ouverte, cliquez sur afin de faire apparaître un bloc de suggestion. Ce bloc contient le contenu de la ligne sélectionné.
Dans ce bloc, modifiez le texte selon votre idée. Vous pouvez aussi prévisualiser le résultat via le bouton "Preview" Une fois terminé, cliquez sur si vous comptez réaliser d'autres suggestions, et mettre en attente ce review, ou sur pour le poster tout de suite.


Exemple de review en attente

Le review que vous venez de faire est en attente d'être mise en ligne. Quand vous aurez terminer votre review, cliquez sur , mettez un commentaire si vous le souhaitez, et en bas, sélectionner
Enfin, cliquer sur afin de le mettre en ligne.

Ce dernier va désormais apparaître dans la discussion.


L'application des reviews est destiné a ceux qui ont créer la Pull Request. Cela vous permet d'approuver les modifications que l'on vous propose, et automatiquement les ajouter sur votre fichier via un commit.

Pour ce faire, aller dans l'onglet Files changed. Les suggestions proposé ce trouveront dans le fichier.


Fenêtre d'une review en attente d'acceptation

La partie du dessus en rouge correspond à la partie actuelle de votre fichier. Ce qui est en dessous en vert correspond à la partie qui sera modifié. Les mots surligné sont ce qui sera réellement modifié.

Si la suggestion vous convient, vous pouvez cliquer sur pour accepter le review, et le mettre en attente. Faite ceci autant de fois que nécessaire pour les autres suggestions.

Une fois cela fait, cliquer sur sur l'une des suggestions


Fenêtre du commit pour accepter les suggestion

Laissez le commentaire tel quel, et cliquer sur afin d'ajouter les suggestions dans le fichier.

Si vous revenez dans la discussion, vous verrez que les suggestions acceptés sont passer en Outdated. C'est normal car elle sont intégré dans l'article désormais.


L'approbation de la Pull Request est destiné à ceux qui ont review la Pull Request. Une fois que la Pull Request à été review et que tout est parfait, il ne reste plus qu'à approuver la Pull Request, afin d'informer les maintainers du wiki que la Pull Request peut être mergé (fusionné) pour être ajouter dans le wiki.

Pour ce faire, aller dans l'onglet Files changed.
Cliquez sur , ensuite sur
Enfin cliquez sur

Enfin, il ne reste plus qu'à attendre qu'un maintainer fassent le nécessaire pour l'ajouter sur le wiki. Dès que la Pull Request sera merge, elle apparaîtra assez rapidement sur le site (dans le pire des cas, 5 heures seront nécessaire).

Il ne reste plus qu'à review ce qui reste, ou à continuer de proposer des Pull Requests. On lâche rien !

Comme vu précédemment, les contrôles automatisés permettent de vérifier que la mise en forme de votre fichier soit correcte, en accord avec les règles d'écriture du wiki. Comme ces règles sont très nombreuses, et qu'il est difficile de tous retenir, ces contrôles ont été mis en place.


Erreur sur un contrôle

Mais dès que l'on rencontre un problème avec ces dernières (comme ici avec la croix rouge), il est parfois difficile de savoir comment le résoudre. Surtout que si elle ne sont pas résolu, elle bloque le merge.

Pour savoir ce qui ne va pas, allez dans l'onglet Files changed.


Une erreur dans le fichier

En haut, vous verrez la ligne qui pose problème. En dessous ce trouve l'erreur qui à été détecté.

Pour savoir à quoi correspond cette erreur, cliquer sur le lien. Vous serez rediriger vers un autre repository.


Repository avec les détails du contrôle réalisé

Sur cette page, aller voir le chapitre Examples pour savoir comment fonctionne la règle (appelé remark).
Ensuite, revenez sur votre PR et modifier votre fichier en conséquence. Ici, un espace à été ajouté entre deux paragraphes, ce qui à générer l'erreur.

Si malgré tout vous n'arrivez pas à résoudre le problème, n'hésitez pas a demander de l'aide sur notre discord.

Parfois, un espace mal placé peut générer une erreur, c'est pour cela qu'il faut bien vérifier sur ce repository (si disponible) pourquoi l'erreur est généré.

Malheureusement, cela peut arriver si quelqu'un d'autre à traduit/modifier le même fichier que vous, et que sa Pull Request à été merge avant la votre.


Un conflit sur la page de votre Pull Request

Si vous avez ce message tout en bas de la page de votre Pull Request, c'est que vous avez un conflit.

Nous allons voir comment résoudre cela.


Je n'évoquerais que cette méthode. Il existe la même méthode pour Visual Studio Code et GitHub.dev, mais elle est trop compliqué.

Pour commencer, cliquez sur


La page de résolution du conflit

Sur cette page, vous allez avoir différents éléments :

1. À gauche, vous avez la liste des fichiers concerné par le conflit.
2. Au centre, le contenu de l'article.

Ce qui nous intéresse est ce qui ce trouve au centre. Plus particulièrement ce qui est en orange : c'est la partie en conflit.

Le conflit est délimité par trois marqueurs :

1. "<<<<<<< ranking-criteria-osu!-fr" qui est le contenu qui ce trouve actuellement sur votre article.
2. ">>>>>>> master" qui est le contenu actuellement présent dans le wiki
3. "=======" qui délimite les deux parties.

Afin de résoudre le conflit, vous devez choisir entre la version que vous avez faite et la version présente sur le wiki.

Vu que l'on fait une mise à jour de l'article, il faut garder la parti que vous avez faite, en prenant garde à regarder quand même la parti présente sur le wiki, afin de ne pas oublier un élément important. Si vous avez un doute, hésitez pas à nous demander.

Pour garder la partie qui nous intéresse, retirez "<<<<<<< ranking-criteria-osu!-fr", et tout ce qui ce trouve entre "=======" et ">>>>>>> master".

Une fois cela fait, aller tout en haut de la page, et cliquez sur . Si le bouton est grisé, c'est que vous n'avez pas encore enlever l'un des trois marqueurs.

Enfin, cliquez sur pour finir la résolution du conflit.

Je vous remercie d'avoir lu jusqu'au bout le tutoriel. Je suis tout à fait conscient qu'il est très long et bourré de détails dans tous les sens, mais je pense qu'il est nécessaire de bien expliquer chaque étape, car chaque personne est différente, et certains peuvent rencontrer des difficultés pour des étapes qui paraissent simple pour d'autres.

GitHub n'est pas simple à prendre en main, surtout quand on commence à rentrer dans les détails, alors un tuto qui explique tout ce que vous devez savoir pour contribuer me semble approprié pour assimiler tout cela.

J'espère de tout cœur qu'avec ces explications, cela vous aura motiver à participer au projet. Ce n'est qu'ensemble que le projet peut revivre, et que l'on peut faire le travail !

Si vous avez la moindre question, n'hésitez pas a me demander sur Discord (doryanr), ou par MP sur osu!.

En guise de conclusion, voici quelques liens utile (que vous pouvez aussi trouver sur le Trello) :

1. Trello du projet
2. Discord dédié au projet
3. Repository de l'osu! wiki
4. Site de référence pour savoir quoi traduire
5. Savoir ce qui doit être traduit ou non
6. Discord officiel d’osu!

Je suis tributaire d'une traduction de qualité.

WitherFlower wrote:

Je suis tributaire d'une traduction de qualité.

Salut, c'est ce que je défend également. D'où le tutoriel complet.

Avec plus de monde, cela serait plus vrai, pour le moment je reste seul a faire le travail, alors il n'y a que moi pour juger de la qualité.

Peut être que les choses changeront du jour au lendemain. En attendant, je suis dans l'attente.

Hello,

Le projet est toujours d'actualité ! même s'il n'y a pas de contributions, nous sommes toujours présents !

Merci à Le_Zozoien de nous avoir rejoint et pour toutes ces contributions récentes !