Aujourd’hui je vais vous parler de Gitmoji, un guide d’utilisation des emojis dans les messages de commit. Après avoir été sceptique à propos de leur utilisation, je me rends compte qu’ils peuvent avoir une vraie utilité pour rendre nos commits plus parlants 🙂
Vous ne le saviez peut-être pas (et vous ne vous êtes peut-être jamais posé la question :p) mais les plateformes comme Gitlab et Github permettent d’ajouter des emojis aux messages de commit (pour github, vous pouvez les retrouver là et pour gitlab, c’est ici 🙂 ).
Gitmoji est tout simplement un guide qui permet d’associer des emojis à une opération .
Par exemple :
Alors quel intérêt ?
Pour qu’un message de commit soit plus explicite, il est courant d’ajouter un préfixe qui va indiquer le type d’opération effectuée (feat, chore, fix etc…)
Par exemple :
fix: add new user
Le préfixe permet d’identifier le type d’opération qui a été réalisée: ici une réparation de bug.
Gitmoji permet de retranscrire les mêmes informations mais de façon plus visuelle.
Ici on aurait:
Si à ce stade, on a du mal à saisir l’avantage de remplacer un préfixe par une image, cela prend tout son sens sur un arbre complet:
Ici, lorsqu’on connaît Gitmoji, on voit en un coup d’œil que les 3 premiers commits sont des ajouts de features, les deux suivants du refactor, les deux derniers une montée de version par exemple.
Sommaire
Des utilitaires vous facilitent l’utilisation de ces emojis au quotidien:
La CLI Gitmoji vous permet de saisir plus facilement les emoji sans avoir à retenir leur code et cela permet par la même occasion de forcer l’ajout du type d’opération dans le commit:
Source: https://github.com/carloscuesta/gitmoji-cli
Un plugin existe également pour la suite Jetbrains: https://plugins.jetbrains.com/plugin/12383-gitmoji-plus-commit-button
Un autre pour Visual Studio:
https://marketplace.visualstudio.com/items?itemName=Vtrois.gitmoji-vscode
Grâce à l’utilisation des emojis référencés dans Gitmoji dans les messages de commit, l’historique devient à mon sens plus agréable à lire et tout aussi détaillé qu’avec l’ajout de préfixes. C’est pour cette raison que je pense qu’il peut être pertinent de l’utiliser dans vos projets 🙂
Written By
Votre changelog reprend les fonctionnalités que vous avez réalisé entre deux versions, ça tombe bien, votre historique git contient ces informations :) On va voir comment les extraire de git pour générer automatiquement un changelog exhaustif et fiable. Le principe Pour faciliter la maintenance de votre projet, il est d’usage d’avoir des commits parlants afin que tous les d...
Photo by Yancy Min on Unsplash Contexte Je suis développeur au quotidien et j'aime développer en dehors du travail également. Parfois, il peut m’arriver de faire un kata entre midi et deux par exemple. J'aime bien du coup garder une trace de mon exerc...
On va prendre un cas concret: j’ai fait un commit et en relisant ma merge request, je me rend compte que certains fichiers ne devraient pas y être: Dans mon cas c’est le fichier src/test/java/com/globaldashboard/unit/dependencies/domain/PomUrlTest.java ...
https://www.youtube.com/watch?v=CvaORpcyKhY Pour ne pas retrouver ses commits de travail dans votre branche de production, il est essentiel de squasher ces commits avant de fusionner votre branche (cf l'image d'illustration! ;) ). Si vous ne savez pas ce ...
