Indication de source à chaque contribution sur les données.

[JeanKouss]

Indication de source à chaque contribution aux données.

Cet API sert des données publiques et nous avons besoin que les données servies soient véridiques et authentiques.
Pour cela je propose que les contributions aux données soient accompagnées de renvoies aux sources de ces données.

Problèmes

• Les données doivent être véridiques et authentiques;
• il est difficile de vérifier et d'apporter des corrections pertinentes aux pulls requests liées aux données parce que les sources ne sont pas précisées;
• les utilisateurs de l'API peuvent avoir envie de vérifier la source des données.

Proposition de solution

Chaque commit concernant les données devrait être accompagné d'une note sur la source des données impactées par le commit.

Fonctionnement

Prérequis : créer un dossier references.

1. Un contributeur modifie ou ajoute des données;
2. Il fait le commit de sa contribution;
3. Il créer un fichier txt dont le nom est celui du code du commit qui contient les modifications. Il place ce fichier dans le dossier references;
4. Il liste les références qui permettront de vérifier les sources de sa contribution dans le ficher (suivant un format que nous pourront décider plus tard);
5. Il fait un commit avec le fichier des références;
6. Il fait un pull request;
7. Un ou plusieurs reviewers se servent du fichier des références pour vérifier l'exactitude de la contribution et valide le pull request.

Avantages de ce fonctionnement

Cette méthode va permettre de lier les commits de modification de données à des fichiers contenant les sources de ces modifications. Avec l'historisation de git, il sera facile de tracer les modifications de données grâce aux commits et avec les commits il sera facile de retrouver les sources des données.

Il sera même possible de développer un outil permettant de remonter en un clic à la source d'une donnée en utilisant l'API de Github.