Conventions du GitHub
Pour contribuer au projet, vous devrez respecter quelques conventions.
Conventions de nommage
Pour écrire nos messages de commit, nous suivons les spécifications Conventional Commits (opens in a new tab) afin de maintenir une cohérence dans nos commits.
Exemples
| Nom | Utilisation |
|---|---|
feat | Ajout d'une nouvelle fonctionnalité |
fix | Correction de bugs |
docs | Quand seul la documentation du code change |
perf | Changement de code améliorant les performances |
revert | Annule un commit précédent |
style | Changement de style (indentation, espaces, etc.) |
test | Ajout ou modification de tests |
refactor | Changement de code qui n'ajoute pas de fonctionnalité ou de correction de bug |
ci | Changement dans les fichiers et scripts de configuration de CI (Github Action) |
chore | Changement qui ne modifie ni les sources ni les tests |
test | Ajout ou modification de tests |
Pour en savoir plus, référez-vous à la documentation Conventional Commits (fr) (opens in a new tab).
Conventions des branches
Pour gérer nos branches, nous utilisons le modèle Git Flow (opens in a new tab).
Git Flow
Git Flow est un modèle de gestion des branches alternatif et non-officiel. Il permet de maintenir une chaîne de commits mieux organisée et cohérente (les modifications en cours de développement dans dev et les modifications développées dans main).
Ce modèle est composé de 5 branches principales/types :
| Nom de la branche | Utilisation |
|---|---|
main | Branche principale |
dev | Branche de développement |
feature/* | Branche(s) de fonctionnalité |
release/* | Branche(s) de release |
hotfix/* | Branche(s) de hotfix |
Pourquoi utiliser Git Flow ?
Git Flow permet, grâce à l'utilisation de deux branches principales, une meilleure organisation de projet. La première branche, nommée main, correspond à la version du code stable, utilisable en production. La seconde, nommée dev, correspond à la version en cours de développement et est donc la branche de travail.