Contribuer

Contribuer à Données bleues, c’est améliorer une ressource pédagogique ouverte : ajouter une source vérifiée, documenter une limite, proposer une activité, corriger un script ou rendre une fiche plus utile en classe.

Voir le parcours Consulter les templates

Principe central

Une contribution doit améliorer au moins une de ces dimensions : qualité pédagogique, vérifiabilité, reproductibilité, clarté des limites ou réutilisation en enseignement.

Quatre contributions utiles

Le projet n’a pas seulement besoin de nouvelles données. Les meilleures contributions rendent les données plus enseignables.

Proposer une source

Identifier un jeu de données québécois ou canadien, vérifier sa provenance, sa licence et son intérêt pédagogique.

Améliorer une fiche

Clarifier l’unité statistique, les variables, les limites, les usages possibles ou le score zéro déchet.

Ajouter une activité

Transformer une source en discussion de 30-45 minutes, laboratoire, étude de cas ou projet long.

Corriger une faiblesse

Réparer un script, actualiser une URL, préciser une licence, signaler une limite ou améliorer une vérification.

Parcours recommandé

Une contribution solide commence par la source, pas par la mise en page.

1. Vérifier la source

Repérer l’organisme producteur, l’URL officielle, la licence, la date d’accès, le format, l’unité statistique et les limites connues.

2. Évaluer l’intérêt pédagogique

Nommer ce que la source permet d’enseigner : importation, nettoyage, visualisation, statistique descriptive, inférence, modélisation, éthique ou communication.

3. Créer la fiche et les métadonnées

Copier les templates, créer un dossier dans datasets/, puis remplir les champs avec des informations vérifiées. Si une information manque, écrire : Je ne sais pas.

4. Ajouter les activités

Décrire une activité courte et une activité longue comme des objets pédagogiques autonomes : question, durée, niveau, concepts, contexte, matériel et notes enseignantes.

5. Valider localement

Exécuter les scripts de vérification avant de proposer la contribution. Une fiche ne doit pas prétendre qu’une donnée existe si le script ne peut pas la télécharger ou la préparer.

Fichiers attendus

Une contribution complète suit la structure du dépôt afin que les catalogues et les pages puissent être régénérés.

Dossier minimal

datasets/nom-du-jeu/
  fiche.qmd
  metadata.yml
  activite-courte.qmd
  activite-courte.yml
  activite-longue.qmd
  activite-longue.yml
  preparation.R

Templates utiles

  • templates/fiche-dataset-template.qmd
  • templates/metadata-template.yml
  • templates/activite-template.qmd
  • templates/activite-metadata-template.yml
  • templates/retour-classe-template.md
  • templates/zero-waste-score-template.yml

Critères de qualité

La contribution doit pouvoir être relue, exécutée et adaptée par une autre personne.

Source

URL officielle, organisme producteur, licence ou conditions de réutilisation, date d’accès et statut de la source.

Pédagogie

Question directrice, concepts visés, niveau, durée, contexte, accroche et limites d’interprétation.

Reproductibilité

Scripts R exécutables depuis la racine du projet, chemins relatifs, dépendances explicites et résultats vérifiables.

Prudence

Les conclusions doivent rester compatibles avec l’unité statistique, la couverture de la source et les droits de réutilisation.

Commandes de vérification

Avant d’ouvrir une pull request, exécuter les vérifications locales.

Rscript scripts/check_datasets.R
Rscript scripts/build_catalogue.R
Rscript scripts/build_activity_catalogue.R
quarto render

Si une commande échoue, corriger la source du problème avant de proposer la contribution.

Proposer la contribution

Pour GitHub, utiliser de préférence une URL SSH.

git remote add origin git@github.com:utilisateur/donnees-bleues.git
git checkout -b ajout-nouveau-dataset
git add .
git commit -m "Ajouter une fiche de jeu de données"
git push -u origin ajout-nouveau-dataset

La pull request devrait expliquer la source ajoutée, l’intérêt pédagogique, les fichiers touchés, les scripts exécutés et les limites encore présentes.

Retour après usage en classe

Une activité documentée n’est pas automatiquement testée en classe. Après une mise en œuvre, consigner la durée réelle, les obstacles, les adaptations, les productions obtenues et la recommandation de réutilisation, sans publier de renseignement personnel ou de travail étudiant.

Consigner un retour d’usage

Une bonne contribution rend le projet plus fiable

Même une petite correction est utile si elle améliore la provenance, la clarté, la reproductibilité ou l’usage en classe.

Lire le cadre zéro déchet Explorer les activités