Qu'est-ce que le programme de maintenance ?

Le code du projet Open edX est hébergé sur GitHub, un site où se déroule l'édition collaborative de code. Le code est organisé en logique code source, des collections de code liées les unes aux autres. Pensez à GitHub comme Google Docs et aux référentiels comme de petits dossiers contenant des documents liés les uns aux autres.

Un problème qui peut survenir avec les référentiels est qu'il n'est pas clair qui en est responsable, ce qui peut amener les membres de la communauté à ne pas savoir à qui demander de l'aide, ou le code devient obsolète (ce qui peut parfois entraîner des problèmes de sécurité). Pour résoudre ce problème, nous avons introduit le Programme des mainteneurs dans une proposition Open edX (OEP-55). Le terme « responsable » fait référence à un individu ou à un groupe de personnes qui servent de leaders pour un composant donné (généralement, un référentiel GitHub) de la plate-forme Open edX. Les mainteneurs assurent à la fois la gestion technique et communautaire.

Que font les Mainteneurs ?

Les mainteneurs ont de nombreuses responsabilités techniques et non techniques. Avant tout, les mainteneurs sont le visage public de chaque composant et sont accueillants et disponibles. Les mainteneurs appliquent les normes du projet - tout comme vous corrigeriez les fautes de frappe et modifieriez la syntaxe dans un document Google, les projets de code ont leurs propres normes que tout le monde devrait suivre.

D'un point de vue non technique, les mainteneurs participent au processus de sélection des principaux contributeurs, s'assurent que les travaux à venir du projet sont effectués en public (c'est-à-dire qu'ils maintiennent une feuille de route publique) et s'assurent que tous les discours du projet suivent l'Open edX. Code de Conduite . Ils s'assurent également que les questions et les rapports de bugs sont triés en temps opportun.

Techniquement, les mainteneurs ont un large éventail de responsabilités. Entre autres choses, ils doivent s'assurer que la documentation appropriée existe, maintenir leurs référentiels à jour avec les mises à jour et les correctifs nécessaires, et maintenir leurs référentiels à jour avec les autres composants Open edX afin qu'ils continuent à bien fonctionner ensemble. De plus, ils comprennent l'architecture de leur composant et ont une « vision technique » documentée – un moyen pour la communauté de comprendre comment le composant fonctionne aujourd'hui et comment il est destiné à évoluer au cours des mois et des années à venir.

Comment se passe le programme ?

Actuellement, le programme est dans sa deuxième phase. Dans la première phase, un petit groupe d'équipes de toute la communauté Open edX (de tCRIL, OpenCraft, eduNEXT et 2U) s'est réuni pour déterminer comment mettre en œuvre de manière pratique les spécificités des exigences du projet de responsable de l'OEP-55. Dans la deuxième phase, plus de mainteneurs rejoignent le programme. L'objectif de cette phase est de s'assurer que les instructions sur la manière de s'installer en tant que mainteneur - et sur la manière d'effectuer les tâches courantes - sont faciles à suivre et répondent aux besoins de la communauté.

Au cours des six prochains mois environ, nous prévoyons de déployer des mainteneurs sur chaque référentiel. Dans le cadre de ce processus, nous pouvons décider de "déprécier" certains référentiels, si personne ne peut intervenir pour les maintenir. Nous espérons que la maintenance des référentiels permettra à la communauté de savoir plus facilement à qui s'adresser en cas de problème et aux codeurs de contribuer au code. Nous profiterons également des avantages d'avoir un code à jour avec les dernières fonctionnalités et correctifs de sécurité.

Pour les questions rejoignez la suite Ouvrir edX Meetup le 27 avril 2023 à 10 h XNUMX (HAE), ou rejoignez le programme de maintenance directement dans le #maintainers-pilot Slack room, et/ou poster dans le Catégorie Développement sur les forums.

 112 vues totales