Skip to content

Latest commit

 

History

History
76 lines (46 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

76 lines (46 loc) · 1.89 KB
Raw

Guide de contribution

Pré-requis

Branches

  • master : Cette branche contient le code stable de l'application. On ne peut y ajouter des modifications qu'en y mergeant des Pull Requests dûment testées et revues.

Toutes les autres branches sont considérées comme des branches de travail.

Cycle de vie d'une contribution

Création d'une branche de travail

  • Se placer sur la branche master et s'assurer qu'elle est à jour :
git checkout master
git rebase origin/master
  • Créer la branche de travail :
git checkout -b <nom-de-la-branche>

Développement

  • Coder ce qui doit l'être, ajouter et commiter les fichiers impactés :
git add <fichiers>
git commit -m "Un message de commit signifiant"

NB : Si la branche de travail concerne un ticket existant, terminer le message de commit par Fixes #<numéro-du-ticket>. Cela permettra de lier automatiquement la PR au ticket et de passer son état à "In progress" dans les projets Github où il est référencé.

  • Mettre à jour la branche de travail à partir de la dernière version de la branche master :
git rebase origin/master

Revue de code

  • Pousser la branche de travail vers le dépôt distant :
git push -f origin <nom-de-la-branche>
  • Créer une Pull Request (PR) :
gh pr create
  • Consulter les éventuels commentaires de revue, échanger à leur sujet et adapter le code en fonction du résultat de la discussion

Intégration à la branche stable

  • Une fois tous les commentaires résolus, merger la branche de travail vers la branche master :
gh pr merge --delete-branch --squash

L'état du ticket lié à la PR passe automatiquement à "Done" dans les projets Github où il est référencé.

Triomphe

Pas de danse idoine ou hululement gutural à définir en fonction des préférences de chacun.