CONTRIBUTING.md 2.5 KB
Newer Older
1 2
# Comment contribuer

3
Cette page liste des bonnes pratiques pour contribuer à ce dépôt.
4 5 6 7 8

## Fichier README.md

Chaque dossier doit comporter un fichier `README.md`.
 
9
Ce fichier décrit le contenu du dossier. Il est affiché par GitLab lors de la navigation.
10

11
Le texte du fichier `README.md` est rédigé au format [Markdown](https://fr.wikipedia.org/wiki/Markdown#Quelques_exemples).
12 13 14 15

## Ajout d'une organisation

Pour ajouter une organisation, il faut 
16
- ajouter les membres de l'organisation comme "developpeurs" du projet, à partir de leurs identifiants de compte GitLab
17
- ajouter un dossier dédié à la racine
18
- présenter l'organisation dans le README du dossier
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
  - description succinte
  - résumé des activités en lien avec le SNDS
  - noms et contacts des responsables de la maintenance du dossier, sachant que des mainteneurs spécifiques peuvent être défini pour chaque sous-dossier, voire chaque fichier 
  - lien vers une page internet de l'organisation.


## Structure d'un dossier d'organisation

Chaque organisation définie une structure de dossiers pour classer ses programmes.

Typiquement, chaque dossier doit comporter au maximum 20 programmes. Au-delà, il est recommandé de créer des sous-dossiers thématiques.


## Éléments de contexte sur les programmes

34
Chaque programme doit être accompagné d'informations de contextes, telles que :
35 36 37 38
  - auteur•e•s ;
  - sujet et contexte d'étude ;
  - dates d'écriture ;
  - données étudiées ;
39
  - période étudié ;
40 41 42 43 44
  - environnement d'exécution (portail SAS de la CNAM, système fils, etc.) ;
  - nombre d'utilisateurs ;
  - processus de relecture éventuel ;
  - etc.
 
45 46 47 48
Pour des programmes contenus dans un seul fichier, il semble préférable d'intégrer ces informations comme commentaire au début du fichier. Ajouter alors une courte présentation de chaque programme dans le README du dossier.

Pour des programmes qui sont divisés en plusieurs fichiers, intégrer 
toutes ces informations dans le README du dossier.
49 50 51 52 53

## Informations générales sur la thématique 

Les éléments de contexte associés au programme doivent être spécifique à ce programme.
 
54
Les informations plus générale sur une thématique doivent être renseignées dans une [fiche](http://documentation-snds.health-data-hub.fr/fiches/) de la documentation du SNDS.
55

56 57
Il s'agit de créer une fiche thématique si elle n'existe pas, ou de compléter une fiche existante avec ses connaissances. 
Il est notamment intéressant d'ajouter à la fiche un lien vers le programme sur gitlab.