Dans le monde du developpement logiciel, maintenir un historique de commits propre et navigable n'est pas seulement une question de proprete mais une pierre angulaire du travail d'equipe efficace et de la gestion de projet. Les messages de commit servent de journal de bord, fournissant des informations sur le pourquoi et le quoi de chaque changement. Cette importance grandit dans les projets multi-developpeurs ou le suivi des changements et la comprehension de leur objectif peuvent devenir complexes.

Ce guide presente les Git hooks comme solution pour appliquer des standards de messages de commit, tels que SemVer et les Conventional Commits, sur divers systemes d'exploitation. Nous explorerons comment implementer ces verifications sur Mac, Linux et Windows, garantissant que les contributions de votre equipe sont coherentes, quel que soit l'environnement de developpement.

Que sont les Git Hooks ?

Les Git hooks sont des scripts qui s'executent automatiquement avant ou apres des evenements du cycle de vie Git, tels que les operations de commit, push et merge. Ils sont un outil puissant pour automatiser et appliquer des regles et des workflows de projet, sans necessiter de supervision manuelle.

Configurer Votre Environnement

L'implementation des Git hooks implique la creation de scripts qui sont declenches a des etapes specifiques du workflow Git. Ces scripts peuvent etre ecrits dans divers langages de script, mais pour la simplicite et la compatibilite multi-plateformes, nous nous concentrerons sur les scripts shell pour Linux et Mac, et les scripts batch ou PowerShell pour Windows.

Pour Linux et Mac :

  1. Localiser le Repertoire Hooks : Naviguez vers .git/hooks dans votre depot. Ce repertoire contient des scripts d'exemple qui peuvent etre modifies ou remplaces.
  2. Creer un Hook commit-msg : Ce hook vous permet d'inspecter le message de commit avant qu'il ne soit finalise. Renommez commit-msg.sample en commit-msg et editez-le pour inclure vos verifications.

Pour Windows :

Les utilisateurs Windows peuvent utiliser Git Bash ou Windows Subsystem for Linux (WSL) pour executer des scripts shell, rendant le processus similaire a celui de Linux et Mac.

Appliquer des Standards de Messages de Commit

La Regle du Message de Commit :

  1. SemVer et Conventional Commits : Les messages de commit doivent commencer par un type (feat, fix, etc.), optionnellement suivi d'une portee, et d'une description succincte du changement.
  2. Nombre Minimum de Mots : Les messages de commit doivent contenir au moins 10 mots pour assurer une clarte descriptive.

Implementer le Hook :

#!/bin/sh
message=$(cat $1)
word_count=$(echo $message | wc -w)

if ! echo “$message” | grep -qE “^(feat|fix|docs|style|refactor|perf|test|chore)((\S+))?: .{10,}$”; then
echo “Le message de commit ne suit pas les standards Conventional Commits.”
exit 1
fi


if [ “$word_count” -lt 10 ]; then
echo “Le message de commit doit contenir au moins 10 mots.”
exit 1
fi

Deploiement et Maintenance

Distribuer et maintenir ces hooks au sein d'une equipe peut etre un defi. Cela peut etre realise via : la documentation, l'automatisation avec des scripts pour les nouveaux developpeurs, et le controle de version en stockant les hooks dans un depot dedie.

Conclusion

Implementer des Git hooks pour appliquer des standards de messages de commit est une strategie puissante pour maintenir une base de code de haute qualite et une collaboration d'equipe efficace. En suivant les etapes decrites dans ce guide, vous pouvez mettre en place un systeme qui fonctionne sur differents systemes d'exploitation, garantissant la coherence et la clarte dans l'historique de commit de votre projet.