Verhoog uw Github-reputatie met de juiste commit-berichten

In plaats van een regel git commit-berichten te schrijven met de commit -m optie, leest u in dit artikel hoe u de juiste vastleggingsberichten schrijft. Een goede commit-berichten zijn belangrijk, omdat het anderen in staat stelt om precies te zien wat je hebt gewijzigd, uw project gemakkelijker te maken voor anderen om te volgen, waardoor u meer bekendheid krijgt met de open source gemeenschap.

Schrijf een correct vastleggingsbericht

In plaats van het vastleggingsbericht in het terminalcommando op te nemen, open je je favoriet teksteditor naar een leeg bestand. Het bericht moet de volgende indeling hebben:

• De eerste regel is de titel, die de hele commit samenvat.
instagram viewer
• Na een lege regel, zou de volgende regel of meerdere regels een leesbare beschrijving moeten zijn die nodig is voor de vastlegging. Dit kan zo lang zijn als gewenst.
• Alle volgende regels zouden de exacte wijzigingen moeten samenvatten die in de code in een dergelijk formaat zijn aangebracht:
  • Bestandsnaam: Regel # - Korte beschrijving van de wijziging.

Voorbeeld Commit Message

Hieronder ziet u een voorbeeld van een vastleggingsbericht:

Docker-ondersteuning toegevoegd, nieuwe is_unique-functie, plus bugfix.
Ondersteuning toegevoegd voor docker-compose en bijgewerkte installatie-instructies indien nodig. Ook bevatte een nieuwe functie binnen de functie check_order () om te controleren op uniekheid, en een kleine bug gerepareerd bij het maken van productslakken.
src / somedir / library.py: 381 - Parameter 'is_unique' toegevoegd aan de functie check_order ().
src / products.py: 194 - Bug opgelost bij het maken van productslak.
docker-compose.yml - Docker-compose-bestand toegevoegd.
docs / install.md - Bijgewerkte installatiehandleiding met onder meer hoe te installeren via Docker.

Bericht vastleggen

Als je nu een commit doet, in plaats van de -m bericht, gebruik de--het dossier optie. Als de bestandsnaam van je commit-bericht bijvoorbeeld commit.txt is, zou je het commando uitvoeren:

git commit --file commit.txt

Dat is alles! Hopelijk helpt dit je om meer gestandaardiseerde en duidelijk vastgelegde berichten aan je volgers te geven, waardoor je project bekendheid krijgt en de open source gemeenschap groeien.

Beeldcredits: Caleb White /Unsplash