Session 4
Cette issue est là pour discuter du contenu de la session 4 de la formation.
Nous avions discuté de :
- Besoins session 4 :
- Introduction 00_00_introduction.qmd
-
Gitlab 01_00_gitlab.qmd
-
GLFM 01_01_gflm.qmd (Olivier)
- Check lists
- Releases 01_02_release.qmd (JBL)
- Templates d’issues 01_03_issue_template.qmd (Marine)
- Organisation en groupes et sous-groupes 01_04_groupe.qmd (Philippe ?)
- Gestion des issues : milestones, boards 01_05_planification.qmd (Olivier)
- Mettre des topics sur des projets 01_06_topic.qmd (Philippe ?)
- Organisation des projets 01_07_organisation_projets.qmd ?
-
Pipelines 01_08_pipeline.qmd (Olivier)
- Définitions CI/CD
- Variables d’intégration
- Illustrations (pour donner envie)
- Releases + artefacts + registry
- Pages
- Use cases de runners "maison" 01_09_runner.qmd (JBL)
- Intégration à Mattermost 01_10_mattermost.qmd (JBL)
-
GLFM 01_01_gflm.qmd (Olivier)
-
Git 02_00_git.qmd
- hooks (pré-push) 02_01_hook.qmd (JBL)
- alias (notamment pour les logs) 02_02_alias.qmd (Olivier)
- cherry-pick 02_03_cherry-pick.qmd (Olivier)
-
rebase -i02_04_rebase-i.qmd (JBL) - bisect 02_05_bisect.qmd ?
-
Bonnes pratiques 03_00_bonnes_pratiques.qmd
- Expliquer le pourquoi des bonnes pratiques 03_01_pourquoi.qmd (Olivier)
-
Présentation du processus de développement 03_02_processus.qmd (JBL)
- …
- Revues de code
- …
-
Structurer son code - faire des onglets par langage 03_03_structuration.qmd
- Utiliser des linters (Olivier)
- Une fonctionnalité/problème = une fonction (<20 lignes dans l’idéal) (JBL)
- Penser "réutilisation" (copier-coller > 2 fois => une fonction)
- Utiliser des paramètres
-
Pas de variables globales (JBL)
- Donner un exemple de code
-
Tester son code 03_04_test.qmd (Olivier)
- Pourquoi tester
- Les différents types de tests
- Utiliser des environnements virtuels 03_05_environnement_virtuel.qmd (JBL)
- Mettre sur git la version de ses dépendances 03_06_dependances.qmd (JBL)
-
Documenter son code 03_07_documentation.qmd (Olivier)
- Documenter les fonctions, modules…
- Documenter le projet
- Le README (et les autres fichiers recommandés - AUTHORS, CONTRIBUTING, LICENCE…)
-
Légal 04_00_ouverture.qmd
- Publier son code, contraintes à INRAE, recommandations de la DipSO 04_01_publication.qmd (Philippe ?)
- Utiliser GitLab pour choisir une licence 04_02_choix_licence_gitlab.qmd (JBL)
- Software Heritage 04_03_software_heritage.qmd (JBL)
- Module de e-formation Oscar voir ici 04_04_oscar.qmd
Activity
Dans la partie Gitlab, il faudrait rajouter un item "organisation des projets" avec topo sur l'exploitation des groupes et sous-groupes et les rôles.
Dans cette même partie, je pense qu'il faut partir du besoin et présenter les outils qui permettent de les satisfaire:
- déclencher des tests automatiques --> CI
- déclencher une compilation automatique --> CI
- Créer des pages Web statiques associées au projet --> Gitlab Pages
- Favoriser la recherche dans les projets --> étiquettes sur les projets
Dans Legal: rajouter un topo sur les exigences en matière de licence, les contraintes INRAE (titulaire, stagiaire, CDD)
Pour la dernière partie, on pourrait la renommer "Ressources complémentaires". On pourra, lorsque le projet de mise en place de la Forge institutionnelle sera terminé, renvoyer vers les Gitlab pages de la forge elle même s'il y en a, vers des projets template bien structurés ...
Pour l'organisation des projets, il est possible de s'appuyer/référencer les travaux des collègues CIRAD : https://gitlab.cirad.fr/cirad/documentation/-/wikis/Les%20sc%C3%A9narios ou plus généralement https://gitlab.cirad.fr/cirad/documentation/-/wikis/home#ii---documentation-utilisateurs
Pour la partie Legal, nous travaillons avec les collègues de la DÀJ sur les conditions d'utilisation de la forge, il y aura des éléments de réponses.
J'ai rajouté cette page : 01_07_organisation_projets.qmd