Découvrir Git

Rédiger un bon message de commit

Testez gratuitement nos 1300 formations

pendant 10 jours !

Tester maintenant Afficher tous les abonnements
Après avoir passé du temps à développer une fonctionnalité, il est important de passer un peu de temps à la décrire. Il s'agit de permettre une meilleure maintenance.
04:19

Transcription

Une des principales raisons de l'utilisation d'un système de versionning est de pouvoir retrouver des fonctionnalités et du code dans un historique. C'est pourquoi il est très important de prendre le temps de bien rédiger son message de commit. Cela fait partie de la philosophie de Git, et également des bonnes pratiques de tous les systèmes de versionning. Très souvent les développeurs peuvent passer plusieurs heures, voire plusieurs jours, à développer une fonctionnalité. Et quand on passe au message de commit, on peut être tenté de le faire très rapidement, de décrire très brièvement la fonctionalité alors qu'on a passé beaucoup de temps à la développer. Il serait vraiment dommage de ne pas passer 5 minutes à décrire correctement cette fonctionalité. Donc pour rédiger un message de commit complet, on a vu tout à l'heure avec le paramètre « -m », qu'il était possible de rédiger directement le message dans la ligne de commande. Mais pour rédiger un message de commit plus complet, donc ici on va aller modifier notre fichier « index.html ». Voilà, comme avant, on le sauvegarde. Donc cette fois-ci, on va faire un Git add. Voilà, comme tout à l'heure, par contre, là, on va faire un Git commit, sans le paramètre « -m ». Donc on nous renvoie vers un éditeur de texte qui a été configuré par défaut, pour pouvoir saisir un message de commit plus complet. Donc la première des règles à observer, est d'ajouter un sujet au message de commit. Donc on va prendre le sujet ici, que j'ai rédigé au préalable. Voilà. Donc le sujet, sur la première ligne. Ensuite on saute une ligne, on laisse une ligne blanche, et on passe au corps du texte. Voilà, donc là je copie / colle le corps du message de commit. Voilà, donc ici on a bien ajouté en première partie, le sujet du message de commit, et en dessous, le corps. Donc au niveau du sujet, il faut rester assez bref. Il faudrait rester idéalement à 50 caractères maximum. Dans l'idéal, on évite les accents, ainsi que les caractères spéciaux. Donc ici je vais remplacer mes accents et mes caractères spéciaux. La bonne pratique suivante, c'est répondre à la question : pourquoi, plutôt que quoi ? Par exemple, je vais pas mettre dans mon message de commit, « j'ai modifié le fichier index.html ». Je vais expliquer pourquoi je l'ai modifié. En fait, dans Git on peut voir, tout l'historique. On peut voir ce que chaque personne a modifié, quand, et comment. Par contre ce qu'on sait pas, c'est l'intention de la personne. On écrit par exemple si le client a formulé une demande particulière, on écrit toujours la raison, le contexte, si possible, pour pouvoir plus tard le retrouver et être le plus efficace possible. Concernant la langue, chacun vous parlera de sa propre expérience. Pour moi, sauf si vous travaillez avec des prestataires à l'étranger, il est préférable de rédiger le message de commit en français pour être lû et compris par le plus grand nombre possible. Ensuite, une fois qu'on a rédigé le message de commit complet, on fait « échappe » pour sortir du mode d'édition de vim et on fait « :wq ». Donc, on enregistre, et notre commit s'est bien passé. Donc pour voir ce qui s'est passé, pour revoir notre message de commit, on fait un Git log. Donc on revoit le message de commit au complet. Ce qui est également possible de faire, c'est un Git log avec l'option one line. Donc avec cette option, on affiche uniquement le sujet du message de commit. On peut également utiliser Git shortlog qui en plus des sujets, reprend l'auteur des commit Voilà donc comment, et pourquoi rédiger de bons messages de commit.

Découvrir Git

Procédez à l’installation et à la configuration de Git. Voyez comment créer un dépôt, manipuler des fichiers source, naviguer dans l'historique, effectuer des recherches, etc.

2h05 (37 vidéos)
Aucun commentaire n´est disponible actuellement
 
Logiciel :
Spécial abonnés
Date de parution :28 sept. 2016

Votre formation est disponible en ligne avec option de téléchargement. Bonne nouvelle : vous ne devez pas choisir entre les deux. Dès que vous achetez une formation, vous disposez des deux options de consultation !

Le téléchargement vous permet de consulter la formation hors ligne et offre une interface plus conviviale. Si vous travaillez sur différents ordinateurs ou que vous ne voulez pas regarder la formation en une seule fois, connectez-vous sur cette page pour consulter en ligne les vidéos de la formation. Nous vous souhaitons un excellent apprentissage avec cette formation vidéo.

N'hésitez pas à nous contacter si vous avez des questions !