Git Commit-bericht: best practices

Git Commit Bericht Best Practices



Bij ontwikkeling is communicatie met andere mensen voor projectbeoordelingen en begrip vrij belangrijk. Git vereist echter een bericht om vast te leggen. Het is de beste manier om verschillende details over het commit-bericht te specificeren. Het beschrijft wat gebruikers in het project hebben gewijzigd. Het is met name belangrijk om een ​​goed commit-bericht te schrijven dat gemakkelijk te lezen en te begrijpen is. Het maakt niet uit of het een lokaal of afgelegen project is.

Dit bericht behandelt het volgende:







Wat is Git Commit-bericht?

Een Git commit-bericht is een korte uitleg van de wijziging die op een bepaald moment in een Git-repository is aangebracht. Het is een record van de wijzigingen die door een ontwikkelaar zijn aangebracht, inclusief codewijzigingen, toevoegingen en verwijderingen.



Wanneer gebruikers hun code wijzigen, organiseren ze deze met behulp van de ' git toevoegen ” commando. Zodra alle wijzigingen zijn geënsceneerd, moeten ze alle wijzigingen doorvoeren. Voer voor dat doel het commando 'git commit' uit. Een commit-bericht is vereist voor elke commit, en het zou moeten beschrijven welke wijzigingen er in de commit zijn aangebracht.



Best Practices voor Git Commit-berichten

Er zijn een groot aantal praktijken voor Git commit-berichten. Sommigen van hen staan ​​​​hieronder vermeld:





  • Houd het commit-bericht kort en begrijpelijk.
  • Het bericht moet minder dan 40 tekens bevatten en de wijzigingen samenvatten.
  • Begin het bericht altijd met een indrukwekkend werkwoord, zoals ' Toevoegen”, “Oplossen”, “Bijwerken” “Verwijderen ” en nog veel meer die een boodschap duidelijk en beknopt maken.
  • Gebruikers kunnen alle commits in een lijst of opsommingsteken aangeven.
  • Voeg een korte uitleg toe waarom de wijzigingen zijn aangebracht in de hoofdtekst van het commit-bericht. Het kan anderen helpen de grondgedachte achter de veranderingen te begrijpen.
  • Splits het onderwerp en de hoofdtekst altijd met een witregel. Dit verbetert de leesbaarheid en helpt de samenvatting van de details te onderscheiden.
  • Gebruik dezelfde opmaak en stijl voor alle commit-berichten in een project.
  • Gebruik altijd de juiste spelling en grammatica.
  • Duidelijke en correcte taal bevordert de leesbaarheid en professionaliteit van de boodschap.

Hoe berichten in Git te committen?

Volg de onderstaande instructie om een ​​bericht in Git vast te leggen:

  • Verwijs naar de gewenste repository.
  • Maak of update een bestand.
  • Houd wijzigingen in het verzamelgebied bij.
  • Gebruik het commando 'git commit' met de vlag '-m' voor het commit-bericht erin.

Stap 1: Ga naar de lokale Git-directory

Start in eerste instantie de Git Bash-terminal op uw systeem en navigeer naar de gewenste lokale repository met behulp van de ' CD ” commando:



CD 'C:\Users\gebruiker\Git\projectrepo'

Stap 2: Bekijk de status van Git

Voer de ' git-status 'Opdracht om de huidige werkstatus te controleren:

git-status

De resulterende afbeelding laat zien dat het werkgebied schoon is en dat er niets te committen is:

Stap 3: Genereer bestanden

Maak een bestand in het werkgebied door de opdracht 'aanraken' samen met de bestandsnaam uit te voeren:

aanraken f3.txt

Stap 4: voeg niet-gevolgde bestanden toe aan het verzamelgebied

Gebruik de volgende opdracht om de wijzigingen van het werkgebied naar het verzamelgebied bij te houden:

git toevoegen f3.txt

Stap 5: Controleer het bijgehouden bestand

Voer vervolgens de onderstaande opdracht uit om te controleren of de wijzigingen zijn bijgehouden of niet:

git-status

Het kan worden opgemerkt dat het bestand met succes is toegevoegd aan het verzamelgebied:

Stap 6: Bericht vastleggen

Leg alle wijzigingen vast met behulp van de ' git vastleggen ” commando:

git vastleggen

De onderstaande uitvoer geeft de opgegeven editornaam aan ' COMMIT_EDITNSG ' is geopend. Voeg een commit-bericht in om alle wijzigingen vast te leggen:

Nadat u het commit-bericht hebt ingevoegd, slaat u de wijzigingen op door op de knop ' CTRL+S ' en de editor sluiten. Als gevolg hiervan zijn alle wijzigingen met succes doorgevoerd:

Verder kunt u het bericht ook specificeren samen met de ' git vastleggen ” commando met behulp van de “ -M ”vlag. Als volgt:

git vastleggen -M 'wijzigingen zijn bijgehouden'

In de onderstaande uitvoer staat dat alle wijzigingen zijn vastgelegd:

Dat is alles over de Git commits-boodschap en best practices ervoor.

Conclusie

Een Git commit-bericht is een korte beschrijving van de wijziging die op een bepaald moment in een Git-repository is aangebracht. Het is noodzakelijk om enkele belangrijke punten in gedachten te houden bij het schrijven van het commit-bericht, zoals het kort en begrijpelijk houden van het commit-bericht. Bovendien moet het bericht minder dan 40 tekens bevatten en de wijzigingen samenvatten. Dit bericht beschreef alles over het Git commit-bericht en de best practices.