Partager vos scripts

Bonnes pratiques

Pour faciliter le partage de votre script ou de votre application pensez à utiliser docker ou tout simplement conda, en créant en plus un fichier listant toutes les dépendances (et leur version) à installer pour que le script fonctionne.

Pensez à vérifier que vous ne laissez pas d'identifiants de connexion sur le repository, que ce soit en brut dans le code ou dans un fichier de configuration.

Pour finir, mettez dans votre repository des fichiers d'exemples pour que l'utilisateur puisse tester votre script.

README

En plus de la documentation des scripts il est important que vous écriviez un README qui se trouvera à la racine de votre projet. Celui-ci doit contenir au minimum :

• une description du script, quel est son but
• comment installer le script
• un exemple d'utilisation (par exemple la ligne de commande)
• contacts

Le fonctionnement du script peut juste être décrit dans la documentation, ici il s'agit surtout d'indiquer à l'utilisateur comment utiliser le script et lui faciliter la navigation dans le code. N'hésitez pas à mettre toutes les informations qui pourraient donc lui faire gagner du temps. Il ne devrait pas avoir besoin de rentrer dans le code pour comprendre comment l'utiliser. Et si votre projet a une architecture complexe n'hésitez pas à indiquer la hiérarchie des dossiers.

Enfin, s'il s'agit d'une application pensez à fournir une documentation contenant des captures d'écran pour accompagner l'utilisateur.

Documentation

En plus d'un dépôt sur GitLab, nous voulons fournir aux utilisateurs une documentation de l'ensemble des scripts disponibles afin de faciliter leur recherche de script. Pour cela nous avons de quelques informations :

• Auteur(s) : les personnes ayant participé au développement du script
• Dépôt : lien vers le dépôt GitLab ou GitHub, ainsi que les étapes à suivre pour demander l'accès au code si celui-ci est sur un repository privé ou s'il est stocké en local chez vous
• Description : une très courte description
• Fonctionnement : un schéma explicatif du script, ainsi qu'une description des fichiers d'entrée et du fonctionnement ou de l'utilisation

Dépôt

Nous avons créé un groupe OpenSILEX-scripts sur la forge INRAE afin de centraliser une partie des scripts (qui sont décrits dans cette documentation). Dans ce groupe peuvent être créés des sous-groupes en fonction des plateformes ou équipes ayant développé y étant associés.

Pour partager votre code vous avez plusieurs solutions en fonction du type de l'endroit où est stocké votre code :

Local

Si votre projet est en local (donc pas sur GitLab ou GitHub), vous pouvez, si vous le souhaitez, le mettre dans un sous-groupe OpenSILEX-scripts sur la forge INRAE. Sinon, vous pouvez nous donner les indications et les contacts afin qu'un utilisateur intéressé par votre script puisse vous demander de lui partager le code. Ces informations seront notées dans la partie décrivant votre script sur cette documentation.

GitHub

Si votre projet est sur GitHub, vous pouvez nous donner le lien vers le repository et nous le mettrons dans la documentation. S'il est en privé, il faudra indiquer les personnes à contacter pour tout utilisateur souhaitant vous demander l'accès.

ForgeMIA

Si votre projet est déjà sur la forge INRAE, plusieurs cas de figure :

• Créer un repository et ajoutez votre projet, dans ce cas évitez de faire des modifications sur l'ancien repository. Notez que l'équipe OpenSilex sera automatiquement owner.
• Liez le repository au groupe : allez sur votre repository et cliquez sur invite group dans l'onglet Manage et sélectionnez le sous-groupe OpenSILEX-scripts auquel vous appartenez (nous pouvons vous en créer un si besoin). Votre projet sera accessible dans l'onglet Shared projects du sous-groupe sélectionné. Toutes les personnes appartenant au groupe OpenSILEX-scripts aura accès à votre projet, mais vous pouvez choisir le niveau d'accessibilité que vous souhaitez lui donner. Attention, si votre repository est privé il faudra donner un rôle supérieur à guest sinon le code ne sera pas visible

Contact

Liste de diffusion : opensilex-script@groupes.renater.fr