Session 4
Cette issue est là pour discuter du contenu de la session 4 de la formation.
Nous avions discuté de :
- Besoins session 4 :
- Intruduction 00_00_introduction.md
- Gitlab 01_00_gitlab.md
-
GLFM 01_01_gflm.md (Olivier)
- Check lists
- Releases 01_02_release.md (JBL)
- Templates d’issues 01_03_issue_template.md (Marine)
- Organisation en groupes et sous-groupes 01_04_groupe.md (Philippe ?)
- Gestion des issues : milestones, boards 01_05_planification.md (Olivier)
- Mettre des topics sur des projets 01_06_topic.md (Philippe ?)
- Pipelines 01_07_pipeline.md (Olivier)
- Définitions CI/CD
- Variables d’intégration
- Illustrations (pour donner envie)
- Releases + artefacts + registry
- Pages
- Use cases de runners "maison" 01_08_runner.md (JBL)
- Intégration à Mattermost 01_10_mattermost.md (JBL)
-
GLFM 01_01_gflm.md (Olivier)
- Git 02_00_git.md
- hooks (pré-push) 02_01_hook.md (JBL)
- alias (notamment pour les logs) 02_02_alias.md (Olivier)
- cherry-pick 02_03_cherry-pick.md (Olivier)
-
rebase -i
02_04_rebase-i.md (JBL) - bisect 02_05_bisect.md ?
- Bonnes pratiques 03_00_bonnes_pratiques.md
- Expliquer le pourquoi des bonnes pratiques 03_01_pourquoi.md (Olivier)
- Présentation du processus de développement 03_02_processus.md (JBL)
- …
- Revues de code
- …
- Structurer son code - faire des onglets par langage 03_03_structuration.md
- 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.md (Olivier)
- Pourquoi tester
- Les différents types de tests
- Utiliser des environnements virtuels 03_05_environnement_virtuel.md (JBL)
- Mettre sur git la version de ses dépendances 03_06_dependances.md (JBL)
- Documenter son code 03_07_documentation.md (Olivier)
- Documenter les fonctions, modules…
- Documenter le projet
- Le README (et les autres fichiers recommandés - AUTHORS, CONTRIBUTING, LICENCE…)
- Légal 04_00_ouverture.md
- Publier son code, contraintes à INRAE, recommandations de la DipSO 04_01_publication.md (Philippe ?)
- Utiliser GitLab pour choisir une licence 04_02_choix_licence_gitlab.md (JBL)
- Software Heritage 04_03_software_heritage.md (JBL)
- Module de e-formation Oscar voir ici 04_04_oscar.md