Ressources RGAA : comment remonter une erreur ou faire une proposition d’amélioration ?

12 octobre, par Audrey Maniez

Depuis la publication de la troisième version du RGAA, l’État met à disposition l’intégralité de ses ressources sur la plateforme de partage Github. Celle-ci peut, au premier abord, sembler être l’apanage des développeurs. C’est pourquoi, dans cet article, nous vous expliquons comment, sans compétences techniques, vous pouvez contribuer à ces ressources RGAA.

Toutes les ressources disponibles sont listées sur la page utilisateur de la DINSIC ; vous y trouvez notamment le référentiel RGAA lui-même et toutes les ressources annexes (guides, étude des bibliothèques JavaScript, etc.). Pour une vue d’ensemble de ces ressources, nous vous invitons à lire notre article sur les ressources RGAA.

Github : présentation rapide

Github est une plateforme qui permet de rendre public du code. Ce peut-être le code d’une application (comme le code de LibreOffice, par exemple), le code d’un site web (par exemple, The Guardian met à disposition son code) ou encore tout simplement, une page de contenu simple (par exemple, cette page de ressources sur l’accessibilité).

Github est une interface graphique pour le logiciel Git, un gestionnaire de version qui permet de garder la trace de toutes les modifications faites sur les fichiers du projet [1].

Pour vous inscrire, rien de plus simple : il suffit de vous rendre sur le formulaire de création de compte.

Les termes à connaître

Dans ce monde du versionnage et du partage de code, il y a quelques termes consacrés à connaître pour s’y retrouver :

  • Un dépôt (« repositery » en anglais) : adresse publique où sont localisés les fichiers et dossiers du projet en question. Par exemple, l’adresse du dépôt du RGAA 3 est https://github.com/DISIC/rgaa_referentiel.
  • Une issue (que l’on pourrait traduire par « ticket » en français) : un message laissé, sur le dépôt concerné, pour décrire un problème lié à l’utilisation ou au code du projet, voire pour partager une idée d’amélioration. Une issue ne contient pas forcément du code.
  • Une pull request (abrégé, tant à l’écrit qu’à l’oral par « PR ») : c’est une proposition de code modifié qui attend d’être acceptée par le propriétaire du dépôt et intégrée (« mergé ») dans le code du dépôt.

Contribuer lorsque l’on ne code pas

Vous utilisez des ressources mais n’êtes pas un féru de code informatique, cela n’empêche pas qui vous ayez des idées d’amélioration ou des corrections à proposer. Admettons que vous soyez un contributeur éditorial ; vous avez lu le guide « Contribuer sur le Web de manière accessible » et vous constatez une erreur (une coquille dans la rédaction, un lien mort, etc.).

Connectez-vous à votre compte Github et accédez au dépôt du guide du contributeur. Sous le nom du dépôt vous trouvez une liste de liens, cliquez sur « Issues ».

Cliquez ensuite sur « New Issue » : un formulaire apparaît. Il ne vous reste plus qu’à rédiger votre commentaire. Donnez un titre explicite et dans la zone de saisie du texte, décrivez l’erreur et sa localisation dans le projet (le nom de la page par exemple). Si vous avez une idée de la correction à apporter, fournissez la également. Github vous permet de structurer le contenu de votre issue en markdown [2].

Une fois votre issue soumise, il vous faudra attendre que le propriétaire du dépôt y réagisse pour savoir si les modifications émises seront intégrées ou non au projet.

À noter

Les issues sur Github ne sont pas comparables à un forum, on ne vient pas donner son avis ou discuter. La gestion des issues est un domaine très particulier, il s’agit principalement de remonter une erreur ou une proposition d’amélioration.

Certains projets sont tellement populaires qu’ils définissent des règles pour la soumission d’issue. Par exemple, YOURLS définit des règles de rédaction pour la remontée d’erreur de son logiciel.

Conclusion

Maintenant, quand on vous dira « Poste une issue sur le dépôt ! », vous saurez de quoi on parle et surtout vous saurez le faire !

Notes

[1Github est une plateforme parmi d’autres. Par exemple, Gitlab est une plateforme similaire qui permet de réaliser sensiblement les mêmes actions.

[2Le markdown est une syntaxe simple qui permet de rapidement structurer un contenu à l’aide de titres, de listes etc.. Pour en savoir plus : https://guides.github.com/features/mastering-markdown/