Guide de contribution

Bienvenue sur le guide de contribution !

Cette documentation est par nature collaborative.

Une section à lire et un guide de contribution sont disponibles dans cette section contribuer.

N'hésitez pas à vous y référer avant toute contribution. Vous pouvez contacter le Health Data Hub en cas de questions.

Quelles contributions ?

Signaler des erreurs ou proposer des améliorations

Les contributions visant à corriger des erreurs ou à compléter des pages existantes sont très précieuses. Toute amélioration, même d'apparence mineure comme la correction de fautes d'orthographe, améliorera pour tous la qualité du contenu.

Vous pouvez pour cela écrire un email aux mainteneurs du projet: opensource@health-data-hub.fr

Vous pouvez également utiliser le système de tickets, appelés issues, dans cet onglet (opens new window). Il vous faudra pour cela créer un compte sur gitlab.com (opens new window).

Chaque ticket représente une opportunité de discussion ouverte pour résoudre le problème évoqué. Tout utilisateur inscrit sur GitLab est en capacité d'y participer.

Corriger ou compléter une fiche existante

Vous trouverez en bas de chaque page, un lien proposant d'éditer la page.

Ce lien vous redirigera sur GitLab, où vous devrez être connectés pour effectuer les modifications. La page suivante de ce guide explique comment utiliser GitLab.

La page modifier une fiche explique comment compléter/modifier une fiche.

Partage de documents existants

De nombreuses organisations ont documenté le SNDS pour des besoins internes. Ce travail n'est souvent pas accessible à la communauté plus large des utilisateurs du SNDS. Une contribution de grande valeur consiste donc à partager publiquement des documents existants dans votre organisation.

Note

Le nom de l'organisation sera indiqué dans la description du document, et dans le nom du fichier.

Une licence MPL-2.0 est appliquée sur tous les fichiers partagés via ce site.

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.

Partage de programmes

Le partage de programmes ou scripts d'analyses est très utile pour la communauté.

Nous partageons dans les fiches de courtes sections de code illustratives.

Les programmes plus conséquents, par exemple un script complet d'analyse, sont partagés dans le dépôt dédié programme-snds (opens new window).

Pour Info

Nous organisons régulièrement des journées de formation (gratuite) pour utiliser GitLab. Ces formations sont organisées via le groupe Meetup Health-Data-Hub (opens new window).