Augmentez votre réputation Github avec des messages de validation appropriés

Au lieu d'écrire des messages de validation git d'une ligne avec le commit -m option, dans cet article, apprenez à écrire des messages de validation appropriés. Un message de validation approprié est important, car il permet aux autres de voir exactement ce que vous avez modifié, ce qui rend votre projet plus facile à suivre pour les autres et vous aide à augmenter votre exposition à la communauté open source.

Rédiger un message de validation approprié

Au lieu d'inclure le message de validation dans la commande du terminal, ouvrez votre éditeur de texte préféré dans un fichier vide. Le message doit respecter le format suivant :

• La première ligne est le titre, résumant l'ensemble du commit.
• Après une ligne vide, la ligne suivante ou plusieurs lignes doivent être toute description lisible nécessaire pour le commit. Cela peut être aussi long que souhaité.
• Toutes les lignes suivantes doivent résumer les modifications exactes apportées au code dans un tel format :
  • Filename:Line# -- Brève description de la modification.

Exemple de message de validation

Ci-dessous, un exemple de message de validation :

 
 Ajout de la prise en charge de Docker, de la nouvelle fonctionnalité is_unique et de la correction de bogues. 
 Ajout de la prise en charge de docker-compose et mise à jour des instructions d'installation si nécessaire. Également inclus une nouvelle fonctionnalité dans la fonction check_order() pour vérifier l'unicité et un petit bogue corrigé lors de la création de slugs de produits. 
 src/somedir/library.py:381 -- Ajout du paramètre 'is_unique' à la fonction check_order(). 
 src/products.py:194 - Correction d'un bug lors de la création d'un slug de produit. 
 docker-compose.yml -- Ajout du fichier docker-compose. 
 docs/install.md -- Guide d'installation mis à jour pour inclure l'installation via Docker. 
  

Message de validation

Lorsque vous faites un commit maintenant, au lieu d'utiliser le -m message, utilisez le --fichier options. Par exemple, si le nom de fichier de votre message de validation est commit.txt, vous exécuterez la commande :

git commit --file commit.txt 

C'est tout ce qu'on peut en dire! J'espère que cela vous aidera à fournir des messages d'engagement plus standardisés et plus clairs à vos abonnés, aidant votre projet à gagner en visibilité et aidant la communauté open source à se développer.

Crédit image :Caleb White/Unsplash