README.md 2.38 KB
Newer Older
Christophe Benz's avatar
Christophe Benz committed
1
# Schémas du Socle Commun des Données Locales (SCDL)
Johan Richer's avatar
Johan Richer committed
2

Christophe Benz's avatar
Christophe Benz committed
3
Ce dépôt sert à indexer les schémas du SCDL afin de permettre [leur documentation](https://scdl.opendatafrance.net/) et leur utilisation dans [Validata](https://go.validata.fr/).
Johan Richer's avatar
Johan Richer committed
4

Christophe Benz's avatar
Christophe Benz committed
5
Le [SCDL](http://opendatalocale.net/scdl/) est un dispositif d'[OpenDataFrance](http://opendatafrance.net/) visant à définir un ensemble de jeux de données prioritaires, normalisés et communs aux collectivités territoriales françaises. Chaque jeu de données identifié fait l'objet d'un schéma : un document décrivant la structure, les champs et les contenus attendus.
Johan Richer's avatar
Johan Richer committed
6

Christophe Benz's avatar
Christophe Benz committed
7
Les schémas sont écrits au format [Table Schema](https://frictionlessdata.io/specs/table-schema/). À partir du fichier JSON, une documentation est générée automatiquement au format Markdown et publiée [ici](https://scdl.opendatafrance.net/).
Johan Richer's avatar
Johan Richer committed
8

Christophe Benz's avatar
Christophe Benz committed
9
## Catalogue des schémas du SCDL
Johan Richer's avatar
Johan Richer committed
10

Christophe Benz's avatar
Christophe Benz committed
11
Le fichier [catalog.json](./catalog.json) décrit le catalogue des schémas du SCDL.
Johan Richer's avatar
Johan Richer committed
12 13 14

## Comment ajouter un schéma au SCDL ?

Christophe Benz's avatar
Christophe Benz committed
15
Prochainement, le processus de contribution sera donc de faire une merge request sur ce dépôt (instructions à venir).
Johan Richer's avatar
Johan Richer committed
16 17 18

### Critères d'acceptation

Christophe Benz's avatar
Christophe Benz committed
19
[OpenDataFrance](http://opendatafrance.net/) se réserve le droit d'accepter ou de refuser l'ajout d'un schéma au sein du SCDL.
Johan Richer's avatar
Johan Richer committed
20

Christophe Benz's avatar
Christophe Benz committed
21 22 23
Pour candidater, un schéma doit :
- être écrit en JSON conformément aux spécifications [Table Schema](https://frictionlessdata.io/specs/table-schema/)
- être nommé `schema.json`.
Johan Richer's avatar
Johan Richer committed
24

Christophe Benz's avatar
Christophe Benz committed
25 26 27 28 29
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 `README.md` peut être publié au même endroit que le fichier `schema.json` afin de compléter la documentation
- 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é
Johan Richer's avatar
Johan Richer committed
30

Christophe Benz's avatar
Christophe Benz committed
31
### Gestion des versions
Johan Richer's avatar
Johan Richer committed
32

Christophe Benz's avatar
Christophe Benz committed
33
Si un schéma est publié dans un dépôt Git, les branches et les tags seront considérés comme des versions du schéma ainsi que les fichiers afférents cités ci-dessus.
Johan Richer's avatar
Johan Richer committed
34

Christophe Benz's avatar
Christophe Benz committed
35
Plus d'informations à ce sujet [dans la documentation sur le cycle de vie des schémas dans Validata](https://git.opendatafrance.net/validata/validata-core/wikis/release-process).