Documentation du SNDS & SNDS OMOP

# Processus de contribution

# Quelles contributions ?

Toute contribution est la bienvenue, elle sera soumise à la licence MPL-2.0 (comme l’ensemble du projet) et nécessite certains pré-requis de maîtrise technique (indiqués ci-dessous). Cette licence copyleft (opens new window) autorise une libre réutilisation du fichier ainsi partagé. Elle impose à toute version dérivée de citer la source d'origine, et d'être publiée sous la même licence afin de garantir les mêmes droits.
Toute personne souhaitant contribuer est invitée à le faire librement. Les contributions peuvent porter sur:

Toutes améliorations, même d'apparence mineure comme la correction de fautes d'orthographe, améliorent pour tous la qualité du contenu. Un processus de relecture et de validation, décrit ci-dessous, a été mis en place afin de garantir un contenu de qualité.

# Processus de relecture et validation

Chaque contribution à la documentation sous la forme d'ajout de contenu est soumise à une relecture par les pairs (afin d’assurer la lisibilité de la contribution ainsi que sa justesse) puis une validation par les mainteneurs du projet afin d’être ajoutée à la documentation principale (branche master) au bon endroit.

# Relecture

Dès lors qu’une contribution est proposée comme ajout à la documentation dans sa version public (hors travail en cours), elle doit être relue par un pair. Pour cela, la procédure de demande de fusion doit être suivie et un relecteur doit être assigné. Ce relecteur peut-être n'importe quel membre de la communauté incluant les maintainers indiqués plus loin. Soit le relecteur invite le contributeur à modifier sa contribution, soit il l’approuve pour passer à l’étape suivante.

# Demande d’aide expertise SNDS

Si besoin est, les experts SNDS du Health Data Hub peuvent aider à la relecture. Vous pouvez également contacter le Hub en cas de doute : <opensource@health-data-hub.fr>

# Correction d’une contribution

Si une relecture appelle une correction, le contributeur est invité à modifier sa contribution et la soumettre à nouveau en suivant la même procédure.

# Validation et fusion

Enfin, après avoir été relue et approuvée, la contribution sera validée par les maintainers qui suivent régulièrement les nouveaux tickets et merge requests.

# Discuter avec la communauté

# Via gitlab

Un système de ticket (opens new window) est disponible via Gitlab. Ce système permet de reporter des erreurs, proposer des améliorations ou de nouveaux sujets de fiche. Un guide d’utilisation des tickets est disponible dans la partie Guide de contribution.

# Via le forum d’entraide

Un forum d’entraide (opens new window) autour du SNDS est disponible. Il constitue un espace d’interaction autour de la documentation du SNDS. Les contributeurs de la documentation sont invités à partager une annonce sur le forum pour donner plus de visibilité à leurs contributions (fiches et programmes).

# Contacter le Health Data Hub et la DREES

Il est possible de contacter par mail les responsables de la documentation ouverte du Health Data Hub et de la Dress en cas de questions, suggestions, signalements d'erreurs :

# Pré-requis et formation

# Pré-requis

La maîtrise de gitlab et la rédaction au format markdown sont des prérequis nécessaires avant de pouvoir contribuer à la documentation collaborative. Ces prérequis peuvent être acquis entre autre, à l’aide de formations dispensées par le Health Data Hub.

# Se former pour contribuer

Des formations (en présentielle et en ligne) pour apprendre à contribuer à la documentation collaborative en passant par GitLab sont régulièrement proposées par le Health Data Hub. Les formations sont annoncées sur meetup (opens new window). La présentation utilisée lors des sessions de formation est disponible en ligne et peut entièrement être utilisée pour apprendre à se former de manière autonome. Ce guide de contribution, également disponible sous la forme de fiches dans la documentation collaborative, contient des mémo sous la forme de Cheat Sheet et des fiches thématiques. Ce guide sert de rappel suite à une formation et permet d’aller plus loin dans le processus de rédaction. Il peut également être utilisé pour apprendre à contribuer de manière autonome.

Des meetup SNDS sont organisés par le Health Data Hub. Ces événements sont annoncés sur meetup (opens new window) et sont à retrouver en vidéo sur le site de la documentation collaborative. Des journées de rédactions sont régulièrement proposées par le Health Data Hub également annoncées sur meetup (opens new window). Ces journées permettent d’aider les contributeurs à publier leurs connaissances sur le site de la documentation, partager des programmes dans un dépôt spécifique sur Gitlab et d’échanger autour de notions spécifiques du SNDS.

← Contactez-nous →