Web design L'importance de créer un bon commit Git

L’importance de créer un bon commit Git

Le logiciel de contrôle de version fait partie intégrante du flux de travail et des pratiques de chaque développeur de logiciels. En fin de compte, Git est le système de contrôle de version le plus utilisé au monde ; ayant été créé pour la première fois en 2005, il s’agit toujours d’un projet open source activement maintenu sur le Web aujourd’hui. En tant que développeur, il existe cinq valeurs de programmation extrêmes (XP) qui doivent toujours être prises en compte lors du démarrage d’un projet :

  • la communication
  • Simplicité
  • Retour d’information
  • Courage
  • Le respect

La communication est fondamentale pour assurer le succès d’un projet, en particulier dans l’environnement de travail d’aujourd’hui où les développeurs ne sont pas toujours dans un bureau assis les uns à côté des autres. C’est là que les messages de validation entrent en jeu ; ce sont des moyens de communication importants entre tous ceux qui travaillent sur un projet, et plus encore pour les futurs développeurs qui s’y associent. Ils donnent aux développeurs un aperçu complet du projet et leur font connaître le but des modifications de code, ce qui leur fait gagner du temps en essayant de comprendre la raison en regardant un écran de code.

Git commit

Les types de commits

Cela finira par arriver à un point dans un projet où vous devrez revenir sur certains des changements qui ont été apportés dans le passé ; que vous essayiez de trouver quand ou comment un bogue a été introduit pour la première fois, ou qui était responsable d’un certain extrait de code tout cela devrait être facilement et facilement disponible dans votre référentiel Git.

Le plus souvent, cependant, lorsque vous regardez l’historique des révisions d’un projet, vous ne verrez que des messages de validation tels que : « Snagging », « Correction de bogues », « Fichier X mis à jour », ou même des messages qui prennent 5 minutes à lire . Tous ces messages de validation ne fournissent aucune information sur les raisons et ce qui a été modifié. Votre seul choix est donc de parcourir manuellement les différences et de vérifier les fichiers un par un, ce qui vous fait perdre beaucoup de temps, ce qui peut être préjudiciable dans certains cas. situations de pression.

Un mauvais message de validation est essentiellement constitué de plusieurs mots vides qui ne fournissent en fait aucune valeur au référentiel ou au projet. Passer un peu plus de temps et rédiger un message descriptif pertinent est une habitude que vous devriez commencer à adopter. Un bon message de validation devrait vous fournir des informations utiles sur ce qui a changé et la raison derrière cela. En fonction de vos propres pratiques et de votre flux de travail, cela dépendra de la façon dont ces messages sont présentés, mais un message récapitulatif clair et concis en haut, suivi d’un message plus détaillé (si nécessaire) ci-dessous fonctionne bien pour de nombreuses équipes.

Parallèlement au message de commit réel, le contenu d’un commit peut également devenir rapidement écrasant s’il n’est pas géré de manière décente. La compilation de plusieurs modifications ou corrections de bogues en un seul gros commit lui fait perdre la majorité de la valeur et est finalement pire que d’avoir simplement un mauvais message de commit cela fait essentiellement de votre commit un tiroir à ordures dans votre maison ou votre bureau, un tiroir qui contient tout des punaises à la petite monnaie et un tiroir qui prend une éternité pour trouver ce que vous cherchez réellement.

le parfait commit git

Un bon commit ne contient que les fichiers pertinents spécifiques à un changement. Ceci, accompagné d’un bon message de validation, rendra la consultation des projets archivés beaucoup plus facile et rapide pour tout le monde. Bien qu’il puisse être difficile d’entrer dans cet état d’esprit; avec une planification et une discipline appropriées, chaque engagement que vous faites à partir de maintenant sera informatif et pourra être digéré par ceux qui le liront.

Branches

Le branchement au sein du contrôle de version est une autre fonctionnalité importante dont il faut tirer parti. Il donne aux développeurs la possibilité de séparer le code stable et fonctionnel du code en cours ou défectueux. Lorsque vous travaillez uniquement sur un petit projet, la création de branches n’est pas très utile pour commencer, cependant, lorsque vous avez un modèle de travail initial, c’est là que la création de nouvelles branches pour tout travail ou fonctionnalité supplémentaire devient nécessaire afin de protéger votre projet de tout bug ou problème.

Si vous utilisez GitHub comme logiciel de contrôle de version, ils ont une stratégie de branchement relativement simple. La branche « principale » contient le code testé et prêt pour la production. Toutes les autres branches (branches de fonctionnalités) qui ont été créées doivent contenir des corrections de bogues ou de nouvelles fonctionnalités sur lesquelles travailler. Ceux-ci seront fusionnés dans la branche « principale » lorsqu’ils seront testés et examinés.

Tirer parti du système de branchement a généralement un résultat positif quel que soit le projet ; Cependant, cela dépend de la taille et du nombre de personnes qui y travailleront pour savoir si la création de branches est réellement nécessaire, car cela peut rapidement devenir compliqué si vous prenez l’habitude de créer de plus en plus de branches pour chaque petit ajout.

git commit branches

Conclusion

Git est un excellent outil utilisé par la grande majorité des développeurs et des entreprises, et il est donc très important de s’assurer que des commits bons et pertinents sont effectués à chaque fois. Avec un peu d’effort et de patience, transformer un message de commit comme « Résolution d’un problème » en quelque chose de descriptif et réellement utile deviendra finalement une seconde nature. Prenez le temps de décider comment structurer réellement vos commits à l’avenir ; car ce qui fonctionne pour un développeur peut ne pas être la bonne solution pour tout le monde.

À l’avenir, n’oubliez pas que les messages de validation doivent être aussi descriptifs et héberger le moins de fichiers possible. Une fois que vous avez découvert un moyen de structurer les messages de commit qui fonctionne pour toute l’équipe, n’oubliez pas de vous y tenir ; et cela à son tour le rendra plus facile à lire et à comprendre lorsque l’on revient sur les projets passés.