Aller au contenu principal

Git

Convention de nommage

Une convention simplifiée pour nommer les branches et les commits dans Git

Nommage des branches

Résumé

Mot clé feature, fix ou hotfix + / + référence du ticket + description en kebab-case

Exemple : feature/CONV-123-creation-nouveau-component-bouton

Utilisation des catégories :

  • feature pour ajouter, refactoriser ou supprimer une fonctionnalité
  • fix pour corriger un bug
  • hotfix pour corriger rapidement un bug sur la prod

Nommage des commits

Résumé

Mot clé feature, fix ou hotfix + / + référence du ticket + : résumé de la tâche

Exemple : git commit -m "feature/CONV-123: Lorem ipsum dolor sit amet"

Bonnes pratique sur les commits

  • Les commits sont à faire avec IntelliJ (cf Config du backend) pour s'assurer que le sonar et le "code inspect" sont passés.
  • Respecter les conventions de nommage
    • éviter le commit unique "fourre-tout"
    • éviter la multiplication des commits pour chaque modification
    • si besoin, reconstruire l'historique de la branche avant la code review
  • Le résultat de l'analyse Sonarlint doit être vérifié avant commit par le développeur. (Voir FQR)