Git Commit Message: Bedste praksis

Git Commit Message Bedste Praksis



I udvikling er det ret vigtigt at kommunikere med andre mennesker for at få projektgennemgang og forståelse. Git kræver dog en besked for at begå. Det er den bedste måde at angive en række detaljer om commit-beskeden. Den beskriver, hvad brugerne har ændret i projektet. Især er det vigtigt at skrive en god forpligtende besked, der er let at læse og forstå. Det er ligegyldigt, om det er et lokalt eller fjerntliggende projekt.

Dette indlæg vil dække følgende:







Hvad er Git Commit Message?

En Git commit besked er en kort forklaring på den modifikation, der blev foretaget i et Git repository på et bestemt tidspunkt. Det er en registrering af de ændringer, der er foretaget af en udvikler, herunder kodeændringer, tilføjelser og sletninger.



Når brugere ændrer deres kode, iscenesætter de dem ved at bruge ' git tilføje ” kommando. Når alle ændringerne er blevet iscenesat, skal de forpligte alle ændringer. Til det formål skal du udføre kommandoen 'git commit'. En commit-meddelelse er påkrævet for hver commit, og den skal beskrive, hvilke ændringer der blev foretaget i commit.



Bedste praksis for Git Commit-beskeder

Der er et stort antal praksisser for Git commit beskeder. Nogle af dem er anført nedenfor:





  • Hold forpligtelsesbudskabet kort og forståeligt.
  • Meddelelsen skal være på mindre end 40 tegn og opsummere ændringerne.
  • Start altid beskeden med et imponerende udsagnsord, såsom ' Tilføj', 'Ret', 'Opdater' 'Slet ” og mange flere, der gør et budskab klart og kortfattet.
  • Brugere kan pege alle commits i en liste eller punktform.
  • Inkluder en kort forklaring på, hvorfor ændringerne blev foretaget i brødteksten i forpligtelsesmeddelelsen. Det kan hjælpe andre til at forstå rationalet bag ændringerne.
  • Opdel altid emne og krop med en tom linje. Dette forbedrer læsbarheden og hjælper med at skelne resuméet fra detaljerne.
  • Brug den samme formatering og stil til alle commit-meddelelser i et projekt.
  • Brug altid korrekt stavning og grammatik.
  • Klart og korrekt sprog forbedrer budskabets læsbarhed og professionalisme.

Hvordan begår meddelelser i Git?

For at begå en besked i Git, følg nedenstående instruktion:

  • Omdiriger til det ønskede lager.
  • Lav eller opdater en fil.
  • Spor ændringer til iscenesættelsesområdet.
  • Brug 'git commit'-kommandoen med '-m'-flaget for commit-meddelelsen i den.

Trin 1: Gå til Local Git Directory

Start først Git Bash-terminalen på dit system og naviger til det ønskede lokale depot ved at bruge ' cd kommando:



cd 'C:\Users\user\Git\projectrepo'

Trin 2: Se status for Git

Udfør ' git status kommando for at kontrollere den aktuelle arbejdsstatus:

git status

Det resulterende billede viser, at arbejdsområdet er rent, og der er intet at forpligte sig til:

Trin 3: Generer filer

Opret en fil i arbejdsområdet ved at køre 'touch'-kommandoen sammen med filnavnet:

røre ved f3.txt

Trin 4: Tilføj usporede filer i iscenesættelsesområde

Brug følgende kommando til at spore ændringerne fra arbejdsområdet til iscenesættelsesområdet:

git tilføje f3.txt

Trin 5: Bekræft den sporede fil

Kør derefter nedenstående kommando for at kontrollere, om ændringerne er blevet sporet eller ej:

git status

Det kan bemærkes, at filen er blevet tilføjet til iscenesættelsesområdet med succes:

Trin 6: Bekræft besked

Forpligt alle ændringerne ved hjælp af ' git commit kommando:

git commit

Det nedenstående output angiver det angivne editornavn ' COMMIT_EDITNSG ” er blevet åbnet. Indsæt en commit-meddelelse for at begå alle ændringerne:

Når du har indsat commit-meddelelsen, skal du gemme ændringerne ved at trykke på ' CTRL+S ” og lukker editoren. Som et resultat er alle ændringerne blevet gennemført med succes:

Desuden kan du også angive meddelelsen sammen med ' git commit kommando ved hjælp af ' -m ' flag. Som følger:

git commit -m 'ændringer er blevet sporet'

Nedenstående output erklærede, at alle ændringerne er blevet forpligtet:

Det handler om Git commits-budskabet og bedste praksis for det.

Konklusion

En Git-commit-besked er en kort beskrivelse af den modifikation, der blev lavet til et Git-lager på et bestemt tidspunkt. Det er nødvendigt at have nogle vigtige punkter i tankerne om at skrive commit-beskeden, såsom at holde commit-beskeden kort og forståelig. Desuden skal meddelelsen være på mindre end 40 tegn og opsummere ændringerne. Dette indlæg beskrev alt om Git commits-beskeden og dens bedste praksis.