search

etalab / transport-profil-netex-fr

Le contenu des normes des données de transport présentes sur le site https://normes.transport.data.gouv.fr.
https://normes.transport.data.gouv.fr
11 stars 8 forks source link

Documenter les outils recommandés pour un travail sur les profils "en local" #66

Open thbar opened 3 months ago

thbar commented 3 months ago

Comme discuté au GT7, @Henault va travailler directement sur un nouveau profil ici et en markdown, et on a une session prévue ce mercredi pour mettre en place les outils pour qu'il puisse travaille en local sur son ordinateur.

J'en profite pour documenter ce que je vais lui proposer (qui sont des outils assez standards).

GitHub Desktop

Si on est sur Mac ou sur Windows (mais pas sous Linux), GitHub propose une application gratuite qui est assez confortable à utiliser (davantage que la ligne de commande aka CLI pour un non développeur).

Elle est disponible ici: https://desktop.github.com

Je détaillerai ici comment s'en servir en quelques lignes.

Visual Studio Code

Disponible sur toutes les plateformes gratuitement, Visual Studio Code permet d'éditer de nombreux formats et dispose de quantités d'extensions pratiques (dont certaines pour faciliter le travail avec le Markdown qui est utilisé pour les profils à présent).

Application disponible ici : https://code.visualstudio.com/

Workflow recommandé

  1. Vérifier qu'on a un compte GitHub
  2. Activer le 2FA (authentification à deux facteurs) dessus
  3. Se faire ajouter aux "équipes" qui peuvent travailler sur le repository du profil concerné (voir via moi ou @TuThoThai typiquement)
  4. Installer GitHub Desktop et VSCode (voir plus haut)
  5. "Cloner" le repository (explications à fournir)
  6. Créer une branche de travail avec un nom descriptif (généralement en minuscules et avec des tirets, pas d'espaces etc)
  7. Faire des "commits" régulièrement dessus pour sauvegarder les travaux
  8. Ne pas hésiter à créer une "Pull Request" dès que possible pour favoriser la discussion sur les travaux
  9. Ne pas hésiter à créer des TODOS avec la syntaxe - [ ] XYZ dans la description pour ne rien oublier
  10. Review en cours de route ou à la fin
  11. Merge et intégration dans main/master (ce qui ne publie pas une nouvelle version, et modifie uniquement la version "en cours")

Voir https://docs.github.com/en/get-started/using-github/github-flow

TODOs

Henault commented 3 months ago

Suite à première session de mise en place des outils reste avec @thbar à clarifier :