diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 06871e0e8ece7a7752f20c01004d311dd5eeff6c..d824133c722deac31c75b96ca219cac1eb82f245 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Comment contribuer au Socle commun des données locales (SCDL) ? -Tous les schémas du SCDL sont réferencés dans le [Catalogue des schémas SCDL](https://git.opendatafrance.net/scdl/catalog/). +Tous les schémas du SCDL sont référencés dans le [Catalogue des schémas SCDL](https://git.opendatafrance.net/scdl/catalog/). L'ajout d'un schéma au catalogue se fait en proposant d'amender le fichier [catalog.json](https://git.opendatafrance.net/scdl/catalog/blob/master/catalog.json) sous forme de _merge request_. @@ -20,11 +20,11 @@ Pour candidater, un schéma doit : - `version` : le numéro de version au format [SemVer](https://semver.org/lang/fr/) - être nommé `schema.json`. - être accompagné d'un fichier `README.md` complet, présentant notamment le contexte de sa création. +- être mis à disposition dans un dépôt Git afin de bénéficier de la gestion des versions (voir ci-dessous). Optionnel : -- le schéma peut être publié dans un dépôt Git afin de bénéficier de la gestion des versions (voir ci-dessous). - un fichier `CHANGELOG.md` peut être publié au même endroit que le fichier `schema.json` afin d'apporter des informations sur les différentes mises à jour du schéma. -- des données tabulaires d'exemple en CSV, valides ou invalides, peuvent également être ajoutées dans un dossier séparé (et référencées dans le schéma grâce à la propriété `resources`). +- des données tabulaires d'exemple sous forme de fichiers CSV, valides ou invalides, peuvent également être ajoutées dans un dossier séparé (et référencées dans le schéma grâce à la propriété `resources`). ## Cycle de vie d'un schéma SCDL