From 99b8e3f870d1b59f9021a1f00e593c38d5caa27a Mon Sep 17 00:00:00 2001 From: Pierre Dittgen Date: Fri, 28 Jun 2019 15:36:09 +0000 Subject: [PATCH 1/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 06871e0..d824133 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 -- GitLab From 4c5fbd7ae88fc7f91e71b68615be35ca04c1bac4 Mon Sep 17 00:00:00 2001 From: Johan Richer Date: Mon, 1 Jul 2019 08:36:36 +0000 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d824133..02bbeeb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,20 +10,21 @@ L'ajout d'un schéma au catalogue se fait en proposant d'amender le fichier [cat Pour candidater, un schéma doit : - être écrit en JSON conformément aux spécifications [Table Schema](https://frictionlessdata.io/specs/table-schema/). Les métadonnées du schéma doivent employer [les propriétés qui ont été standardisées](https://github.com/frictionlessdata/specs/blob/master/specs/patterns.md#table-schema-metadata-properties), avec au minimum : - - `name` : identifiant, ou "slug" - - `title` : nom courant - - `description` - - `homepage` : page d'accueil ou dépôt Git - - `path` : URL de cette version du schéma - - `created` : date de création - - `lastModified` : date de publication de cette version - - `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). + - `name` : identifiant, ou "slug" ; + - `title` : nom courant ; + - `description` ; + - `homepage` : page d'accueil ou dépôt Git ; + - `path` : URL de cette version du schéma ; + - `created` : date de création ; + - `lastModified` : date de publication de cette version ; + - `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 en ligne sur une URL stable. Optionnel : -- 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. +- être mis à disposition 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 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 -- GitLab