Si vous êtes développeur, ou dans le milieu du développement, vous êtes très certainement familier avec l’outil bien connu des développeurs, j’ai nommé Git.

Pour celles et ceux d’entre vous qui ne seraient pas familier avec Git, je vous renvoie vers la page Wikipédia qui vous expliquera cela bien mieux que moi.

Pour les autres, nous allons aujourd’hui voir un outil formidable pour agrémenter vos messages de commit afin de les rendre plus lisible et de comprendre ce que fait un commit en un seul coup d’oeil. J’ai donc l’honneur de vous présenter Gitmoji

Présentation

Gitmoji est un outil développé par Carlos Cuesta et se présente sous la forme d’un site internet.

Le but de cet outil est très simple, associé un emoji à un message de commit.

Pour vulgariser, un message de commit est un message décrivant ce qui a été ajouté, modifié ou encore supprimé sur un repo git. Par exemple, si j’ajoute une fonctionnalité d’inscription et de connexion sur le projet sur lequel je travaille, quand j’enverrai (push) cette fonctionnalité sur le repo git, j’écrirai un message de commit qui ressemblerait probablement à celui-ci:

Add inscription and connection

Ce message a pour but de décrire ce qui a été modifié, ainsi, les autres personnes travaillant sur le même projet pourront savoir pourquoi certains fichiers ont été ajoutés ou modifiés.

Avec Gitmoji, ce message ressemblerait à:

✨ Add inscription and connection

Différences

Vous vous dites surement que cela ne change pas grand-chose et que c’est purement cosmétique. Ce à quoi je répondrais: oui.. et non.

Vous pourrez voir sur le site de Gitmoji que chaque emoji décrit une situation particulière:

À force d’utiliser cet outil, vous pourrez identifier en un clin d’oeil ce qui a été modifié sur votre projet, ainsi lorsque vous verrez l’historique des commits depuis votre client Git préféré vous saurez tout de suite à quoi vous avez à faire.

Par exemple, voici l’historique des commits d’un projet qui n’utilise pas Gitmoji:

Comme vous le voyez, tous les messages ont l’air de se ressembler, et on ne peut pas discerner facilement ce qui a été modifié sans lire un à un les messages de commit.

Voici maintenant un historique de commit d’un projet utilisant Gitmoji:

Comme vous pouvez le constater, chaque message possède un émoji décrivant ce qu’il s’est passé sur ce commit. Il suffit d’apercevoir un “🐛” pour savoir que ce commit a servi à corriger un bug, un “➕” signifie qu’une dépendance a été ajoutée au projet, un “🔥” signifie que des fichiers ou du code a été supprimé et un “✨” signifie qu’une nouvelle fonctionnalité a été ajoutée.

En devenant familier avec Gitmoji vous pourrez ainsi distinguer chaque action sur un projet de manière simple et ludique.

Changelog

Un Changelog, se traduisant littéralement par “Journal des modifications”, est un fichier dans lequel on retrouve une liste des modifications, triées par ordre décroissant, qui ont été apportées à un projet.

Il existe une convention pour les messages de commits appelée Conventional Commits. Un des avantages de cette convention est de générer facilement un Changelog suivant les messages de commits d’un projet.

Par exemple, si mon message de commit commence par fix:, un outil me permettra d’automatiquement de classer ce commit dans une section Bug fixes, si celui-ci commence par feat:, le commit sera cette fois-ci classé dans la section Features.

Mais, comment fait-on si on utilise Gitmoji ?

Et bien, Carlos Cuesta a pensé à tout ! En effet, celui-ci a également créé un outil nommé Gitmoji-changelog permettant de générer un changelog en se basant sur les émojis précédant un message de commit.

Une fois l’outil installé, il vous suffira de vous rendre à la racine de votre repo depuis un terminal et de lancer la commande gitmoji-changelog afin de générer un changelog pour votre projet.

L’outil classera automatiquement vos commits dans les bonnes catégories suivant l’émoji, par exemple, les émojis “✨” et “👷‍♂️” correspondent tout deux à leur manière à un ajout, l’outil les classera alors dans la catégorie Added.

Bien entendu, tout est configurable !

Vous vous retrouverez donc avec des jolis changelogs, dont chaque modification sera facile à identifier !

Conclusion

Gitmoji est un outil, bien que débordant de simplicité, qui permet d’améliorer grandement la lisibilité et la clarté des messages de commits d’un projet git tout en y ajoutant une touche de fun. J’ai découvert cet outil dans ma précédente entreprise qui l’utilisait et depuis je l’utilise dans tous mes projets.

Et vous, qu’en pensez-vous ? Êtes-vous client de ce genre d’outils ? Et, quel que soit votre réponse, pourquoi ?

Vous connaissez d’autres outils permettant d’améliorer ses messages de commits ou tout simplement des outils permettant d’améliorer la clarté générale d’un projet ? N’hésitez pas à me les faire partager, ceux-ci feront peut-être l’objet d’un prochain article 😁.