En développement, la communication avec d'autres personnes pour l'examen et la compréhension du projet est très importante. Cependant, Git nécessite un message pour valider. C'est le meilleur moyen de spécifier une variété de détails sur le message de validation. Il décrit ce que les utilisateurs ont modifié dans le projet. En particulier, il est important d'écrire un bon message de validation facile à lire et à comprendre. Peu importe qu'il s'agisse d'un projet local ou distant.
Ce poste couvrira les éléments suivants :
- Qu'est-ce que le message de validation Git ?
- Meilleures pratiques pour les messages de validation Git
- Comment valider des messages dans Git ?
Qu'est-ce que le message de validation Git ?
Un message de validation Git est une brève explication de la modification apportée à un référentiel Git à un moment donné. Il s'agit d'un enregistrement des modifications apportées par un développeur, y compris les modifications de code, les ajouts et les suppressions.
Lorsque les utilisateurs modifient leur code, ils les mettent en scène en utilisant le ' git ajouter ' commande. Une fois que tous les changements ont été mis en scène, ils doivent valider tous les changements. Pour cela, exécutez la commande « git commit ». Un message de validation est requis pour chaque validation, et il doit décrire les modifications apportées à la validation.
Meilleures pratiques pour les messages de validation Git
Il existe un grand nombre de pratiques pour les messages de validation Git. Certains d'entre eux sont énumérés ci-dessous:
- Gardez le message de validation court et compréhensible.
- Le message doit faire moins de 40 caractères et résumer les modifications.
- Commencez toujours le message par un verbe impressionnant, tel que ' Ajouter', 'Corriger', 'Mettre à jour' 'Supprimer ” et bien d'autres qui rendent un message clair et concis.
- Les utilisateurs peuvent pointer tous les commits dans une liste ou sous forme de puce.
- Incluez une brève explication de la raison pour laquelle les modifications ont été apportées dans le corps du message de validation. Cela peut aider les autres à comprendre la raison d'être des changements.
- Séparez toujours le sujet et le corps avec une ligne vide. Cela améliore la lisibilité et aide à distinguer le résumé des détails.
- Utilisez la même mise en forme et le même style pour tous les messages de validation d'un projet.
- Utilisez toujours une orthographe et une grammaire appropriées.
- Un langage clair et correct améliore la lisibilité et le professionnalisme du message.
Comment valider des messages dans Git ?
Pour valider un message dans Git, suivez les instructions ci-dessous :
- Rediriger vers le référentiel souhaité.
- Créer ou mettre à jour un fichier.
- Suivez les modifications apportées à la zone de préparation.
- Utilisez la commande 'git commit' avec le drapeau '-m' pour le message de validation qu'il contient.
Étape 1 : Accédez au répertoire Git local
Initialement, lancez le terminal Git Bash sur votre système et accédez au référentiel local souhaité en utilisant le ' CD ' commande:
CD 'C:\Users\user\Git\projectrepo'
Étape 2 : Afficher l'état de Git
Exécutez le ' statut git ” commande pour vérifier l'état de fonctionnement actuel :
statut gitL'image résultante montre que la zone de travail est propre et qu'il n'y a rien à valider :
Étape 3 : générer des fichiers
Créez un fichier dans la zone de travail en exécutant la commande 'touch' avec le nom du fichier :
touche f3.txt 
Étape 4 : Ajouter des fichiers non suivis dans la zone de transit
Utilisez la commande suivante pour suivre les modifications de la zone de travail à la zone de préparation :
git ajouter f3.txt 
Étape 5 : Vérifier le fichier suivi
Ensuite, exécutez la commande ci-dessous pour vérifier si les modifications ont été suivies ou non :
statut gitOn peut remarquer que le fichier a été ajouté avec succès à la zone de staging :
Étape 6 : Message de validation
Validez toutes les modifications à l'aide du ' git commet ' commande:
git commetLa sortie fournie ci-dessous indique le nom de l'éditeur spécifié ' COMMIT_EDITNSG ' a été ouvert. Insérez un message de validation pour valider toutes les modifications :
Après avoir inséré le message de validation, enregistrez les modifications en appuyant sur ' CTRL+S ” et fermeture de l'éditeur. En conséquence, toutes les modifications ont été validées avec succès :
De plus, vous pouvez également spécifier le message avec le ' git commet ” à l'aide de la touche “ -m ' drapeau. Comme suit:
git commet -m 'les changements ont été suivis'La sortie ci-dessous indique que toutes les modifications ont été validées :
C'est tout ce qui concerne le message des commits Git et les meilleures pratiques pour cela.
Conclusion
Un message de validation Git est une brève description de la modification apportée à un référentiel Git à un moment donné. Il est nécessaire de garder à l'esprit certains points importants concernant l'écriture du message de validation, comme garder le message de validation court et compréhensible. De plus, le message doit faire moins de 40 caractères et résumer les modifications. Cet article décrit tout sur le message des commits Git et ses meilleures pratiques.