Moteur de Workflow Git
Applique des workflows Git cohérents, y compris pour les messages de commit, le nommage des branches et les processus de PR.
Quand l'utiliser
- Création de commits ou de branches
- Revue de code ou création de PR
- L'utilisateur mentionne "workflow Git", "message de commit", "nommage de branche" ou "pull request"
Instructions
1. Détecter les conventions existantes
Vérifiez :
- Les modèles
.github/ou.gitlab/ CONTRIBUTING.md- Les motifs de messages de commit existants
- Les motifs de nommage de branches
2. Commits conventionnels
Format : type(scope): description
Types :
feat: Nouvelle fonctionnalitéfix: Correction de bugdocs: Documentationstyle: Formatage, points-virgules manquantsrefactor: Restructuration du codeperf: Amélioration de performancetest: Ajout de testschore: Maintenance, dépendances
Exemples :
feat(auth): ajouter la connexion OAuth2
fix(api): gérer la réponse nulle dans le point de terminaison utilisateur
docs(readme): mettre à jour les instructions d'installation
refactor(utils): simplifier la logique de formatage de date
3. Nommage des branches
Motifs courants :
feature/user-authentication
bugfix/login-error-handling
hotfix/critical-security-patch
release/v1.2.0
chore/update-dependencies
Validation :
- Minuscules avec tirets
- Préfixé par le type
- Nom descriptif
- Numéro de ticket si applicable :
feature/123-add-dark-mode
4. Validation du message de commit
Bon commit :
feat(payments): intégrer la passerelle de paiement Stripe
- Ajouter la configuration du SDK Stripe
- Implémenter la création d'intention de paiement
- Ajouter le gestionnaire de webhook pour les événements de paiement
- Mettre à jour les tests pour le flux de paiement
Closes #456
Vérifiez :
- Ligne de sujet ≤ 50 caractères
- Corps limité à 72 caractères
- Ligne vide entre le sujet et le corps
- Mode impératif ("ajouter" pas "ajouté")
- Référence au ticket/issue
5. Modèle de PR
Créez .github/PULL_REQUEST_TEMPLATE.md :
## Description
<!-- Que fait cette PR ? -->
## Type de changement
- [ ] Correction de bug
- [ ] Nouvelle fonctionnalité
- [ ] Changement cassant
- [ ] Mise à jour de documentation
## Tests
<!-- Comment cela a-t-il été testé ? -->
## Checklist
- [ ] Le code respecte les directives de style du projet
- [ ] Auto-revue effectuée
- [ ] Commentaires ajoutés pour le code complexe
- [ ] Documentation mise à jour
- [ ] Tests ajoutés/mis à jour
- [ ] Tous les tests passent
- [ ] Aucun nouvel avertissement
## Tickets associés
Closes #
6. Hooks de commit
Pre-commit :
#!/bin/sh
# .git/hooks/pre-commit
# Exécuter le linter
npm run lint
# Exécuter les tests
npm test
# Vérifier les données sensibles
if git diff --cached | grep -i "password\|api_key\|secret"; then
echo "Erreur : Données sensibles potentielles détectées"
exit 1
fi
Commit-msg :
#!/bin/sh
# .git/hooks/commit-msg
commit_msg=$(cat "$1")
# Vérifier le format de commit conventionnel
if ! echo "$commit_msg" | grep -qE "^(feat|fix|docs|style|refactor|perf|test|chore)(\(.+\))?: .+"; then
echo "Erreur : Le message de commit doit suivre le format des commits conventionnels"
echo "Exemple : feat(auth): ajouter la fonctionnalité de connexion"
exit 1
fi
7. Valider les commits existants
Vérifiez la conformité des motifs des commits récents :
git log --oneline -20 | grep -v "^[a-f0-9]\{7\} (feat|fix|docs|style|refactor|perf|test|chore)"
8. Générer un changelog
À partir des commits conventionnels :
# Avec standard-version
npx standard-version
# Ou manuellement en regroupant par type
git log --pretty=format:"%s" | grep "^feat" > features.txt
git log --pretty=format:"%s" | grep "^fix" > fixes.txt
9. Branches protégées
Paramètres GitHub :
- Exiger des revues de PR
- Exiger des vérifications de statut
- Exiger des commits signés
- Restreindre qui peut pousser
- Exiger un historique linéaire
10. Bonnes pratiques
- Commits atomiques : Un seul changement logique par commit
- Messages descriptifs : Expliquer pourquoi, pas quoi
- Commits fréquents : Petits et fréquents plutôt que grands et rares
- Historique propre : Squash/rebase avant de fusionner
- Signer les commits : Signature GPG pour la sécurité
- Référencer les tickets : Lier au système de suivi
Modèle de commit Git
Créez .gitmessage :
<type>(<scope>): <sujet>
<corps>
<pied>
# Type : feat, fix, docs, style, refactor, perf, test, chore
# Scope : composant ou fichier affecté
# Sujet : impératif, minuscule, sans point, ≤ 50 caractères
# Corps : expliquer quoi et pourquoi, pas comment, limité à 72 caractères
# Pied : changements cassants, références de tickets
Définissez-le comme modèle :
git config --global commit.template ~/.gitmessage
Fichiers d'accompagnement
templates/PULL_REQUEST_TEMPLATE.mdtemplates/commit-msg-hook.shtemplates/.gitmessage