Aller au contenu

Bonnes pratiques GIT

Les modèles et guidelines proposés ici sont recommandés par les équipes PinkSalmon et ne sont pas obligatoires.

Elles sont fortement recommandées dans les cas:

  • d'utilisation d'autres services cloud PinkSalmon
  • de participation de dévelopement des équipes PinkSalmon

Astuce

Si vous n'êtes pas familié avec GIT, veuillez visiter Les bases de Git

Branches

Stratégie

  • La modèle conseillé est le modèle Git Gitflow

Bonnes pratiques

  • utilisez uniquement des minuscules dans les noms de branche
  • les branches que vous créez doivent toujours commencer par feature/, bugfix/ ou release/

Merge Request ou Pull Request

Bonnes pratiques

  • utilisez le préfixe draft: ou WIP: tant que le MR ou PR n'est pas prête pour une revue

Avant de soumettre votre MR ou PR pour revue:

  • vérifiez que votre nom de branche suit les guidelines
  • faites un rebase
  • résolvez vos conflits s'il y en a
  • vérifiez que vous avez bien éxécuté les tests et qu'ils sont réussis (si applicable)
  • vérifiez que la documentation est à jour avec vos changements (si applicable)
  • vérifiez que la readme est à jour avec vos changements (si applicable)
  • vérifiez que le build fonctionne dans votre contexte si vous avez modifier une ressource du build (si applicable)