Booster votre réputation GitHub : rédigez des messages de commit impeccables

Au lieu d'utiliser des messages de commit Git en une seule ligne avec l'option git commit -m, apprenez à rédiger des messages structurés et professionnels. Un bon message de commit est essentiel : il permet aux contributeurs de comprendre précisément vos changements, facilite le suivi du projet et renforce votre visibilité dans la communauté open source.

Rédiger un message de commit approprié

Évitez d'inclure le message directement dans la commande terminal. Ouvrez plutôt votre éditeur de texte préféré dans un fichier vide. Respectez ce format standard :

• Première ligne : un titre concis résumant l'ensemble du commit (50 caractères max).
• Après une ligne vide : une description détaillée et lisible, aussi longue que nécessaire.
• Lignes suivantes : résumé précis des modifications au format Filename:Ligne# -- Description brève.

Exemple de message de commit

Voici un exemple concret :

Ajout de la prise en charge Docker, nouvelle fonctionnalité is_unique et corrections de bugs.

Ajout de docker-compose et mise à jour des instructions d'installation si nécessaire. Nouvelle fonctionnalité dans check_order() pour vérifier l'unicité et correction d'un bug lors de la création de slugs produits.

src/somedir/library.py:381 -- Ajout du paramètre 'is_unique' à check_order().
src/products.py:194 -- Correction d'un bug sur la création de slug produit.
docker-compose.yml -- Ajout du fichier docker-compose.
docs/install.md -- Mise à jour du guide d'installation pour Docker.

Utiliser votre message de commit

Pour committer, utilisez l'option -F ou --file au lieu de -m. Exemple :

git commit -F commit.txt

Voilà ! Adoptez ces pratiques pour des messages clairs et standardisés. Vos abonnés y verront une marque de professionnalisme, boostant la visibilité de votre projet et la communauté open source.

Crédit image : Caleb White/Unsplash