Passerelle Bidirectionnelle entre Git et MediaWiki

Résumé

L'an passé, un prototype de passerelle bidirectionnelle entre Git et MediaWiki a été développée (git-remote-mediawiki, par l'équipe de David Amouyal, Claire Fousse, Arnaud Lacurie, et Jeremie Nikaes), qui 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.

Il reste beaucoup à faire pour que ce projet soit facilement utilisable, et robuste. L'objectif du projet est d'améliorer cet outil.

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 de l'an passé avait été bien accueillie par la communauté de développeurs de Git, et le prototype développé a finalement été inclu dans le répertoire contrib/ du code source de Git.

Sujet proposé pour 2012

L'outil existant est un bon prototype, mais reste beaucoup de limites :

• Beaucoup de fonctionalités manquent, par exemple la gestion des fichiers (Media:) en plus des pages classiques du wiki, une gestion correcte de l'authentification, ... (cf. la liste en haut du fichier source de git-remote-mediawiki pour des idées de fonctionalités à ajouter).
• Le script n'a été testé que manuellement sur quelques sénarios simples. Il serait intéressant de développer un environnement de test automatique, utilisable pour tester des cas plus complexes, et surtout assurer la non-regression au fil du développement. Un environnement de test est non-trivial, puisqu'il demande de faire communiquer une instance de MediaWiki (initialisé correctement pour chaque cas de test) avec le programme a tester.

Chacun de ces points pourrait donner lieu à un projet.

É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.
• Organisation générale des projet semestre 2 : https://intranet.ensimag.fr/KIOSK/Ensimag/2A/TroncCommun/ProjetGene/
• Projets « Génie Logiciel et Langages » : http://ensiwiki.ensimag.fr/index.php/Projets_de_sp%C3%A9cialit%C3%A9_G%C3%A9nie_logiciel_et_langages

Voir aussi

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