Vous souhaitez améliorer votre réputation sur GitHub? Voici comment formater les messages de validation.
Au lieu d'écrire des messages git commit sur une ligne avec le commit -m option, dans cet article, apprenez à écrire des messages de validation appropriés. Un bon message de validation est important, car il permet aux autres de voir exactement ce que vous avez modifié, rendre votre projet plus facile à suivre pour les autres contribuant à augmenter votre exposition à l'open source communauté.
Écrire un message de validation approprié
Au lieu d'inclure le message de validation dans la commande du terminal, ouvrez votre favori éditeur de texte dans un fichier vierge. Le message doit être conforme au format suivant:
Vous recherchez un éditeur de texte de terminal pour Linux? Le choix principal est entre Vim et nano! Voici comment ils se comparent.
- 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 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:
Ajout de la prise en charge de Docker, nouvelle fonctionnalité is_unique, plus correction de bogue.
Ajout de la prise en charge de docker-compose et des instructions d'installation mises à jour si nécessaire. Également inclus une nouvelle fonctionnalité dans la fonction check_order () pour vérifier l'unicité, et correction d'un petit bogue lors de la création de slugs de produit.
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 comment installer via Docker.
Message de validation
Lorsque vous effectuez un commit maintenant, au lieu d'utiliser le -m message, utilisez le--déposer option. Par exemple, si le nom de fichier de votre message de validation est commit.txt, vous exécuterez la commande:
git commit --file commit.txtC'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, en aidant votre projet à gagner en visibilité et en aidant le Open source la communauté grandit.
Crédit d'image: Caleb White /Unsplash
Envie de partager vos projets de développement en ligne? Voici comment démarrer avec votre premier référentiel Github.
- Programmation
- GitHub
Abonnez-vous à notre newsletter
Rejoignez notre newsletter pour des conseils techniques, des critiques, des ebooks gratuits et des offres exclusives!
Un pas de plus…!
Veuillez confirmer votre adresse e-mail dans l'e-mail que nous venons de vous envoyer.
