Comprendre les bases : Mais au fait, c'est quoi « commettre » ?
Pourquoi les noms de commits sont-ils si importants ? (Plus que tu ne le crois !)
Tu te dis peut-être : « Bof, un nom de commit, c'est juste un détail. » FAUX ! C'est crucial. Un bon nom de commit, c'est comme une pancarte claire et précise sur une autoroute. Ça permet à toi (dans six mois, quand tu auras tout oublié) et à tes collègues de comprendre rapidement ce qui a été fait et pourquoi. Imagine une équipe qui travaille sur un projet complexe. Sans noms de commits clairs, c'est le chaos assuré ! On passe son temps à déchiffrer le code, à essayer de comprendre l'intention derrière chaque changement. C'est une perte de temps colossale, et ça peut mener à des erreurs coûteuses. Et soyons honnêtes, qui a envie de passer son temps à débugger du code illisible ? Personne !
Les règles d'or pour des noms de commits au top (qui vont te faire passer pour un pro)
Maintenant, entrons dans le vif du sujet. Comment écrire des noms de commits qui soient à la fois clairs, concis et informatifs ? Voici quelques règles d'or à suivre :
Utilise l'impératif présent
C'est la règle la plus importante. Un nom de commit doit être une instruction, une action. Par exemple, au lieu de « Ajout d'une fonctionnalité de connexion », écris « Ajoute une fonctionnalité de connexion ». C'est plus direct, plus clair, plus efficace. C'est comme si tu donnais un ordre à ton futur toi (ou à tes collègues) : « Fais ça ! »
Sois concis (mais pas trop !)
Un nom de commit doit être court et précis. Idéalement, il ne devrait pas dépasser 50 caractères. Mais attention, il ne faut pas non plus tomber dans l'excès inverse et écrire des noms de commits cryptiques et incompréhensibles. Trouve le juste milieu. Le but est de donner une idée claire et rapide du changement effectué, sans rentrer dans les détails.
Décris le *quoi* et le *pourquoi* (pas seulement le *comment*)
C'est là où beaucoup de gens se plantent. Ils se contentent de décrire la manière dont le changement a été implémenté, sans expliquer pourquoi ce changement était nécessaire. Par exemple, au lieu de « Modifie le code pour utiliser une boucle for », écris « Améliore la performance du calcul en utilisant une boucle for ». Tu expliques non seulement ce que tu as fait, mais aussi pourquoi tu l'as fait.
Utilise des mots-clés pertinents
Les mots-clés sont tes amis. Ils permettent de retrouver facilement un commit dans l'historique du projet. Utilise des mots-clés qui décrivent la fonctionnalité, le module ou le composant modifié. Par exemple, « feat(authentication): Ajoute une validation des adresses e-mail ». Le mot-clé « authentication » indique clairement que ce commit concerne le module d'authentification.
Écris en anglais (le plus souvent)
Même si tu travailles sur un projet en En français, il est souvent préférable d'écrire les noms de commits en anglais. Pourquoi ? Parce que l'anglais est la langue universelle du développement logiciel. Ça facilite la collaboration avec des développeurs du monde entier, et ça rend ton code plus accessible à la communauté open source. Mais bon, si ton équipe est 100% En française et que vous n'avez aucune intention de collaborer avec des anglophones, tu peux très bien écrire tes noms de commits en En français. L'important, c'est d'être cohérent.
Exemples concrets de bons et de mauvais noms de commits (pour que tu comprennes bien)
Rien de tel que quelques exemples pour illustrer ce qu'il faut faire et ne pas faire :
- \n
- Mauvais : « Fix bug » (On ne sait pas quel bug est corrigé) \n
- Bon : « Corrige le bug d'affichage des prix sur la page produit » (On sait exactement quel bug est corrigé) \n
- Mauvais : « Update code » (C'est vague et imprécis) \n
- Bon : « Refactorise le code du module de paiement pour améliorer la lisibilité » (On sait ce qui a été refactorisé et pourquoi) \n
- Mauvais : « Add feature » (Quelle fonctionnalité ?) \n
- Bon : « Implémente la fonctionnalité de recherche par hashtag » (On sait quelle fonctionnalité a été ajoutée) \n
Conclusion : Deviens un maître du commit !
Voilà, tu as maintenant toutes les clés en main pour écrire des noms de commits qui vont faire de toi un vrai pro du développement logiciel. N'oublie pas : un bon nom de commit, c'est un cadeau que tu fais à ton futur toi et à tes collègues. Alors, prends le temps d'écrire des noms de commits clairs, concis et informatifs. Tu ne le regretteras pas ! Et maintenant, vas-y, committe ! Mais committe bien, hein !
" }