Bien démarrer : les bonnes pratiques

Cette page rassemble les bonnes pratiques liées à la création, la publication et le maintien de projets dans la Forge des communs numériques éducatifs.

Si certains passages vous semblent manquer de précision, n'hésitez pas écrire à la communauté.

Renseigner son profil sur la Forge

Avant toute publication, il est recommandé de renseigner soigneusement son profil :

choisir un nom complet (par exemple : Prénom Nom ou un pseudo professionnel cohérent) ;
ajouter un avatar (logo, image stylisée, photo professionnelle) ;
rédiger une courte biographie précisant son rôle ou ses centres d’intérêt (enseignant, développeur, membre d’un collectif, etc.) ;
associer au compte une adresse mail (professionnelle de préférence).

Un profil bien renseigné facilite les échanges, instaure un climat de confiance et permet aux autres collègues de rentrer plus facilement en contact avec les personnes responsables des projets.

Créer son projet

Un projet sur la Forge regroupe les fichiers, la documentation, les tickets, l’historique et les éventuelles contributions. Avant de le créer, il est important de prendre le temps de choisir un nom de projet et un nom de groupe explicites et originaux.

a. Identifier des projets voisins #

Avant ou pendant la création d'un projet, il est utile de repérer des projets similaires déjà présents sur la Forge.

Ces projets voisins peuvent partager des objectifs proches ou un format commun ou viser le même public…

Les identifier permet :

d’éviter la duplication de travail ;
de s’inspirer de bonnes pratiques ;
d’initier d’éventuelles collaborations.

Quelques pistes :

utiliser la recherche sur la Forge ;
explorer la cartographie ;
échanger dans un des salons Tchap.

Favoriser les synergies entre les projets renforce la dynamique collective et améliore la qualité des ressources.

b. Bien nommer le projet #

Un bon nom de projet permet de comprendre immédiatement le contenu ou l’objectif de la ressource, sans avoir besoin de contexte supplémentaire.

À éviter : ressources, exos, maths, grammaire

À préférer :

REL Grammaire Markdown (par exemple pour ressources éducatives libres en grammaire, au format Markdown)
Flashcards Timeline Histoire Cycle 4
Générateur d’évaluations Maths LaTeX Collège
Simulateur Algorithmique Python Lycée

N'oubliez pas d’ajouter un avatar, de renseigner la description et d’indiquer des tags à votre projet.
Pour cela, rendez-vous dans les paramètres du projet, puis dans la section Général.

Cela permet de mieux identifier les projets et de faciliter leur recherche dans la Forge.

⚠️ Pour éviter des problèmes lors de la publication du projet en tant que Pages, il est recommandé de ne pas utiliser le point (.) comme séparateur dans le nom du projet (préférer les tirets ou les espaces).

c. Bien nommer le groupe #

Cette étape est facultative. Il est tout à fait possible de publier un projet dans son propre espace personnel. Cela peut convenir, notamment lorsqu'on souhaite conserver une autorité claire sur le projet. Cela indique qu’il est ouvert à la consultation et éventuellement à la contribution, mais qu’il n’est pas porté comme un projet communautaire.

Pour favoriser les collaborations et permettre une gouvernance partagée, il est toutefois préférable de créer un groupe dédié dans lequel plusieurs personnes peuvent être définies comme propriétaires du projet. Cela facilite la coanimation, la continuité du projet, et évite de tout centraliser sur un seul compte personnel.

Le groupe représente l’entité à laquelle appartient le projet (personne, équipe disciplinaire, collectif, académie…). Il est recommandé d’adopter une nomenclature explicite et cohérente.

À éviter : ressources, maths6e, projets, groupe1, outils, Lycée Van Gogh

À préférer :

Académie-Nancy-Metz-Maths
Collectif-Grammaire-Libre
Communauté-FlashCards-Forge
OutilsNumériques-FLS
Lycée Van Gogh NomDeLaVille (associer le nom de la ville au nom de l’établissement permet d’éviter les doublons et de mieux identifier le groupe)

Cela permet de structurer l’espace de la Forge et de faciliter la recherche et la découverte de projets similaires.

⚠️ De la même manière que pour les noms des projets, pour éviter des problèmes lors de la publication du projet en tant que Pages, il est recommandé de ne pas utiliser le point (.) comme séparateur dans le nom du projet (préférer les tirets ou les espaces).

Choisir une licence libre

Assigner une licence libre est une étape essentielle. Elle garantit à d’autres collègues la possibilité de consulter, réutiliser, adapter et redistribuer la ressource, tout en respectant les droits des personnes porteuses du projet.

Recommandations #

Éviter si possible les clauses "non commerciales", même si elles sont juridiquement acceptables dans un cadre éducatif.
Ce type de clause limite les possibilités de réutilisation, notamment lorsqu’on souhaite fusionner plusieurs ressources ou construire des outils collaboratifs à partir d’une base existante.

Les licences avec une clause NC (non commerciale) peuvent poser des difficultés d’intégration avec d’autres projets ou ressources, en particulier ceux diffusés sous des licences plus permissives comme CC-BY ou MIT. Cela limite les possibilités de réutilisation et de combinaison entre projets.

Licences recommandées : #

Pour les ressources éducatives :
- Creative Commons BY
- Creative Commons BY-SA
Pour les logiciels :
- MIT
- Gnu GPL v3

Documenter la ressource (README.md)

Un fichier README.md placé à la racine du dépôt est indispensable pour présenter le projet. Il sert de point d’entrée aux futurs collègues.
Il est conseillé d’y faire figurer :

une description claire du projet et de son objectif ;
le public visé (niveau scolaire, discipline, type d’usages…) ;
les éventuels pré-requis techniques ;
des captures d’écran ou une démonstration ;
des instructions simples pour installer ou utiliser la ressource ;
la licence choisie ;
des indications sur les contributions attendues ou à venir (bugs connus, lien vers la page des tickets…).

Partager sur la Forge

Plusieurs méthodes permettent de déposer les fichiers du projet sur la Forge :

via l’éditeur WebIDE intégré à l’interface ;
en ligne de commande avec Git (git clone, git push, etc.) ;
à partir d’un éditeur local tel que VScodium par exemple.

a. Dépôt simple #

Dans la majorité des cas, en particulier pour des ressources éducatives libres (documents, exercices, générateurs, banques de questions, etc.), un dépôt simple suffit.

Celui-ci contient :

les fichiers sources (ex : .md, .tex, .ods…),
un README.md,
une licence,
éventuellement une arborescence claire (ex : docs/, exemples/, images/…).

Cela permet un partage rapide et efficace, tout en favorisant la transparence et la réutilisation.

b. Publication sous forme de page #

Dans certains cas, notamment pour des applications web statiques (ex : jeux pédagogiques, visualisations interactives, générateurs, simulations…), il peut être pertinent d’activer la fonctionnalité Pages du projet.

Cela permet :

de publier une version en ligne utilisable immédiatement par les élèves ou les collègues ;
de présenter une démonstration fonctionnelle sans avoir besoin d’installer quoi que ce soit.

Exemples de cas d’usage :

simulateur mathématique en JavaScript ;
jeu éducatif hébergé en HTML/CSS/JS ;
visualiseur de cartes interactives.

Faire communauté

a. Annoncer sa publication dans des salons Tchap #

Une fois le projet publié, il est recommandé de l’annoncer dans les salons Tchap dédiés à la mutualisation ou aux thématiques associées.

Cela permet de faire connaître le travail réalisé, d’obtenir des retours constructifs, et de susciter des contributions ou des usages dans d’autres contextes.

b. Participer à des évènements #

La communauté de la forge se retrouve régulièrement lors d’évènements en présentiel ou en ligne.
Ces temps forts permettent de rencontrer d’autres porteurs et porteuses de projets, de contribuer ensemble, de valoriser des ressources ou de faire émerger de nouvelles idées.

Ces rencontres renforcent la dynamique collective, permettent de partager des pratiques concrètes et contribuent à faire vivre une culture commune du libre dans l’éducation.

Proposer une intégration dans la cartographie

Une fois que le projet est mature, et s'il respecte les critères d’ouverture (notamment une licence libre sans clause NC), il est possible de le proposer pour une intégration à la cartographie des communs numériques éducatifs.

Étapes à suivre :

vérifier que le projet est bien documenté et publiquement accessible ;
ouvrir un ticket sur le dépôt correspondant à la cartographie ;
renseigner les informations demandées (nom, URL, description, licence…).

La cartographie valorise les initiatives libres et facilite leur repérage par les collègues.

Maintenir sa ressource

Une ressource libre est vivante. Elle peut évoluer grâce aux retours des collègues, aux contributions extérieures et à l’évolution des programmes ou des besoins.

Il est utile de :

corriger les éventuelles erreurs ou bugs signalés ;
répondre aux questions et suggestions ;
intégrer ou discuter les propositions de modification (requêtes de fusions, ou merge requests) ;
tenir à jour les fichiers et les instructions d’installation ;
envisager des évolutions fonctionnelles si le besoin s’en fait sentir ;
participer à une phase de test par la communauté de la Forge.