Passerelle Bidirectionnelle entre Git et MediaWiki

Résumé

Depuis 2011, un prototype de passerelle bidirectionnelle entre Git et MediaWiki a été développée par des étudiants Ensimag : git-remote-mediawiki. Cet outil permet d'utiliser les commandes Git classiques (clone, pull, push, ...) pour éditer du contenu en ligne sur un Wiki comme EnsiWiki ou Wikipedia, sans utiliser de navigateur web.

Le projet est déjà utilisable et relativement robuste, mais il reste beaucoup de choses à faire pour l'améliorer.

Les étudiants devront s'initier au flot de développement de la communauté de développeurs de Git, en particulier :

• La revue de code par des tiers,
• L'utilisation poussée d'un gestionnaire de versions,
• L'application stricte de styles de codage,
• Les tests automatisés,
• L'utilisation des mailing-lists comme outil de communication et d'entraide.

Contexte et Objectifs

Pour éditer des textes de manière collaborative, deux outils sont très utilisés aujourd'hui :

• les gestionnaires de versions (par exemple Git) permettent de travailler localement sur une hiérarchie de fichiers en utilisant les outils de son choix (éditeur, compilateur, etc) et fournissent des fonctionnalités avancées (les branches notamment).
• les wikis (par exemple, MediaWiki, utilisé par Wikipedia et EnsiWiki) permettent une édition en ligne (dans un navigateur), et semblent plus simples d'utilisation que les gestionnaires de versions, surtout s'il s'agit d'effectuer une simple modification mineure comme une correction typographique.

Chaque solution a ses avantages et ses inconvénients, et il n'est pas simple aujourd'hui de bénéficier du meilleur des deux mondes (des solutions de Wiki basées sur Git comme IkiWiki ou Golum existent, mais ne sont pas acceptables dans tous les contextes).

L'idée de ce projet est de permettre un pont entre Git et MediaWiki : Dans un sens, pouvoir récupérer des modifications depuis un wiki avec « git clone » et « git pull », et de l'autre, pouvoir en publier avec « git push » (en bénéficiant de toutes les fonctionnalités de Git pour faire les commits localement).

La proposition a été bien accueillie par la communauté Git par la communauté de développeurs de Git. Le prototype développé est maintenant inclu dans le répertoire contrib/ du code source de Git.

Sujet proposé pour 2015

Une liste d'idées d'améliorations est maintenue dans le tracker GitHub du projet :

https://github.com/moy/Git-Mediawiki/issues

La ou les équipes pouront choisir quelques-unes de ces idées et les implémenter.

Évaluation

L'évaluation prendra en compte les points suivants (liste non-exhaustive) :

• Qualité/quantité du code produit
• Attitude vis-à-vis de la communauté
• Acceptation du code par la communauté
• Soutenance et rapport final

Organisation

• Nombre d'équipe : 1 ou 2 équipes.
• Taille de l'équipe : entre 2 et 5 étudiants.
• Méthodes agiles en projet de spécialité : http://ensiwiki.ensimag.fr/index.php/Méthodes_agiles_en_projet_de_spécialité
• Organisation générale des projet de spécialité : http://ensiwiki.ensimag.fr/index.php/Projets_de_specialit%C3%A9_-_2A
• Projets « Génie Logiciel et logiciel libre » : http://ensiwiki.ensimag.fr/index.php/Projets_de_sp%C3%A9cialit%C3%A9_G%C3%A9nie_logiciel_et_logiciel_libre

Historique

• 2011 : lancement du projet par l'équipe de David Amouyal, Claire Fousse, Arnaud Lacurie, et Jeremie Nikaes
• 2012 : gestion des fichiers joints, possibilité d'utiliser git-credential pour s'authentifier, et ajout d'une base de tests automatisée.
• 2013 : nettoyage de code avec perlcritic, "git mw preview"

Voir aussi

• Cette autre proposition de projet qui concerne entre autres Git.