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

Hibou Gourou

Au lieu d'écrire des messages de validation git sur une ligne avec l'option commit -m , dans cet article, découvrez comment é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 facilite le suivi de votre projet pour les autres, contribuant ainsi à augmenter votre exposition à la communauté open source.

Écrire un message de validation correct

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 être conforme au format suivant:

  • La première ligne est le titre, résumant le commit entier.
  • Après une ligne vide, la ligne suivante ou plusieurs lignes devraient être toute description lisible nécessaire pour la validation. 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:
    • Nom de fichier: Ligne # – Brève description de la modification.

Exemple de message de validation

Ci-dessous, un exemple de message de validation:

 
Added Docker support, new is_unique feature, plus bug fix.
 Added support for docker-compose and updated installation instruction as necessary. Also included a new feature within check_order() function to check for uniqueness, and fixed small bug when creating product slugs.
 src/somedir/library.py:381 -- Added 'is_unique' parameter to the check_order() function.
 src/products.py:194 -- Fixed bug when creating product slug.
 docker-compose.yml -- Added docker-compose file.
 docs/install.md -- Updated installation guide to include how to install via Docker.

Message de validation

Lorsque vous effectuez une validation maintenant, au lieu d'utiliser le message -m , utilisez l'option –file . 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 normalisés et plus clairs à vos abonnés, à aider votre projet à se faire connaître et à aider la communauté open source à se développer.

Crédit d'image: Caleb White / Unsplash