Guide de contribution

Bienvenue sur le guide de contribution !

Cette documentation est par nature collaborative. Toute contribution est bienvenue.

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 projets :

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

Chaque issue 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.

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.

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.

Où publier ces documents ?

Vous avez deux options pour publier ces documents

  • sur le site internet de votre organisation Nous les référencerons via un lien hypertexte dans la section ressources externes.

  • sur ce site de documentation Nous ajouterons alors un lien de téléchargement dans la section des documents partagés via ce projet, et nous les convertirons en page de documentation si approprié.

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 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 illustrative.

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