GitHub : mes 11 préfixes de commits
Pour que mon historique reste compréhensible dans le temps j’ai pris l’habitude de préfixer mes commits. J’ai compilé 11 préfixes de commits dans cet article.
Je travaille depuis 2018 avec un outil de versioning. Ce type d’outil est formidable pour garder une trace du travail effectué et permettre de revenir en arrière pour n’importe quel besoin. Il faut cependant être rigoureux dans son utilisation sinon une catastrophe peut arriver…
Une erreur de jeunesse
Je ne faisais pas l’effort, mon équipe non plus, au début de documenter mes commits et le résultat de ce laisser-aller ne s’est pas fait attendre.
Je m’en souviens encore, c’était un lundi matin.
Je venais de finir une nouvelle fonctionnalité pour une application web, tout allait bien mais j’avais fais une erreur de boucle infinie (qui d’ailleurs fonctionnait 5 minutes avant de passer en prod, on dit tous ça non ?).
Au moment de vouloir revenir en arrière - PROBLÈME - où est la dernière version fonctionnelle ? Aucune idée… 30 minutes de solitude !
Depuis pour éviter ce genre de déconvenue je prends le temps de préfixer tous mes commits (même les plus insignifiants). Après de longues recherches et pas mal de tests je suis parvenue à compiler 11 préfixes de commits qui fonctionnent plutôt bien pour moi.
Mes 11 préfixes de commits
Sans plus attendre je vous livre ma compilation des 11 préfixes de commits que j’utilise avec une courte description de leur cas d’usage :
- Fix : résolution d’un bug
- Feat : ajout d’une nouvelle fonctionnalité
- Chore : mise à jour des dépendances (c’est aussi un peu le fourre-tout quand le commit ne correspond à rien d’autre)
- Refactor : refactorisation de code
- Docs : modifications sur le README ou les fichiers de documentation
- Style : changements sur la mise en page ou les feuilles de styles
- Test : modifications ou création de tests
- Perf : tout ce qui améliore les performances
- CI : modifications sur les fichiers (ou scripts) de Continuous Integration
- Build : modifications sur les fichiers (ou scripts) de build
- Revert : retour à un précédent commit
Conclusion
Avec ces préfixes j’arrive à garder une cohérence et une bonne compréhension de tous mes commits. Ce type de travail peut paraitre fastidieux mais croyez-moi, au final, vous allez tellement gagner en tranquillité d’esprit.
Documenter son travail c’est une bonne habitude à prendre.
