Git hjälper olika, distribuerade team att arbeta på en enhetlig kodbas. Med denna kraft följer ett ansvar: att lämna bra beskrivningar av dina förändringar.

Commit-meddelanden är korta beskrivningar av varje commit i ett versionskontrollsystem som Git. När du gör ändringar i dina projektfiler bör du ge ett meddelande som förklarar vad de gör eller varför du gjorde dem.

Commit-meddelanden fungerar som en form av dokumentation och kommunikation. De spelar en avgörande roll för att upprätthålla en tydlig och organiserad versionshistorik för ett projekt. Lär dig hur du skriver bra engagemangmeddelanden och de andra medlemmarna i ditt team kommer att uppskatta ditt arbete ännu mer.

Strukturen för ett bra engagemang

Ett bra exempel på ett commit-meddelande inkluderar fyra sektioner: Typ, Description, Body och Footer.

Såhär:

: 
[valfri text]
[valfri sidfot]

Typ

Typen beskriver vilken typ av förändring som görs i det aktuella åtagandet. Du kan använda vilket system som helst som passar dina omständigheter. Här är till exempel några exempel på sökord som du kan använda för att signalera varje typ av förändring, tillsammans med exempelanvändning:

instagram viewer

  • bedrift: dina ändringar introducerar en ny funktion.
  • fixera: du fixar en bugg.
  • refaktor: din ändra refactors-kod utan att fixa en bugg eller lägga till en ny funktion.
  • testa: du gör några testrelaterade ändringar. Till exempel när du skriva tester med Jest eller några andra testramverk du väljer.
  • Syssla: ändringar som inte är relaterade till en fix, funktion eller test. Till exempel uppdatering av beroenden.
  • docs: när du uppdaterar dokumentationen.
  • stil: ändringar som inte påverkar innebörden av koden, som att lägga till blanksteg, saknade semikolon, etc.
  • perfekt: ändringar relaterade till prestandaförbättringar.
  • bygga: när du gör ändringar som påverkar byggfilerna.
  • ci: förändringar relaterade till kontinuerlig integration.
  • återgå: när du återgår till en tidigare commit.

Beskrivning

"Beskrivningen" av ett commit-meddelande är en kortfattad och beskrivande sammanfattning av ändringarna som gjorts i commit. Den fungerar som en rubrik som fångar essensen av åtagandet.

Tänk på följande när du skriver beskrivningen:

  • Gör det tillräckligt tydligt och specifikt för att beskriva åtagandet med ett ögonkast.
  • Gör det kort och koncist. Helst skulle det vara bäst att begränsa den till 50 tecken eller mindre.
  • Skriv det i presens, även om du beskriver ändringar som redan gjorts.
  • Använd den imperativa stämningen när du skriver den.
  • Börja med stor bokstav.
  • Avsluta det inte med en period.

Till exempel:

feat: Implementera växling av mörkt läge för startsidan

Det här exemplet visar hur du kan skriva beskrivningen för en commit som implementerar mörkt läge. Den använder bedrift typ eftersom det introducerar en ny funktion.

Kropp (valfritt)

Brödsektionen i ett commit-meddelande ger ytterligare detaljer och sammanhang om ändringarna som gjorts i commit. Du behöver inte alltid ett organ, men det kan hjälpa till att ge mer information, förklara en förändrings resonemang eller beskriva eventuella tekniska överväganden.

Här är några saker att notera när du skriver brödtextdelen av ett commit-meddelande:

  • Git radbryter aldrig text automatiskt, så radbryt den manuellt med 72 tecken när du skriver brödtexten. Detta ger Git tillräckligt med utrymme för att dra in text, vilket gör den mer läsbar.
  • Använd kroppen för att förklara vad som hände i förändringen, varför du gjorde förändringen och resonemanget bakom din förändring.
  • Du måste lämna en tom rad mellan beskrivningsraden och brödtexten. Detta gör att Git kan skilja mellan dem.
  • Om commit introducerar flera ändringar eller påverkar olika delar av kodbasen, överväg att använda punktpunkter eller stycken för att bryta ner ändringarna. Detta förbättrar läsbarheten och hjälper läsarna att förstå de olika aspekterna av åtagandet.

Till exempel:

feat: Lägg till GitHub som en OAuth-leverantör
Integrera GitHub som en OAuth-leverantör för att möjliggöra sömlös 
autentisering med GitHub-konton.


- Implementera OAuth-autentiseringsflöde med GitHub API
- Konfigurera nödvändiga slutpunkter och inställningar för GitHub-autentisering
- Uppdatera användargränssnittet för att inkludera GitHub-inloggningsalternativ

Exemplet ovan visar ett bra Git commit-meddelande för en funktion som lägger till GitHub som OAuth-leverantör till din ansökan. Detta commit-meddelande har en kortfattad sammanfattningsrad (50 tecken eller mindre), en mer detaljerad förklarande text (omsluten till cirka 72 tecken) och punktpunkter för ytterligare information.

Sidfoten i ett commit-meddelande är en valfri del som tillhandahåller ytterligare information eller metadata relaterad till commit. Det är vanligtvis placerat efter kroppssektionen, åtskilda av en tom rad. Sidfoten kan innehålla olika typer av information, såsom referenser till relaterade problem, taggar eller speciella anteckningar.

När du refererar till problem, pull-förfrågningar eller andra relaterade objekt, använd lämplig syntax eller format som krävs av ditt projekts problemspårningssystem. Detta säkerställer att referenserna är korrekt igenkända och länkade.

Till exempel:

feat: Lägg till GitHub som OAuth-leverantör
Integrera GitHub som en OAuth-leverantör för att möjliggöra sömlös 
autentisering med GitHub-konton.


- Implementera OAuth-autentiseringsflöde med GitHub API
- Konfigurera nödvändiga slutpunkter och inställningar för GitHub-autentisering
- Uppdatera användargränssnittet för att inkludera GitHub-inloggningsalternativ
Löser: #123
Se även: #456, #789

Sidfoten hänvisar till den relaterade frågan #123 och nämner andra relaterade frågor #456 och #789 för ytterligare sammanhang.

Lägger till Commit-meddelandet

Du kan skriva commit-meddelanden med hjälp av -m flagga följt av commit-meddelandet inom citattecken (valfritt men rekommenderas).

De -m flaggan är idealisk för korta commit-meddelanden, vanligtvis inklusive typ och beskrivning.

Till exempel:

git commit -m "chore: Byt linter till ESlint"

Men när ditt commit-meddelande kräver mer detaljer, såsom en brödtext och en sidfot, är det bättre att du skriver commit i en textredigerare eller IDE.

Alternativt kan du skriva långa commit-meddelanden i en textfil och använda --fil flagga för att ange commit-meddelanden som innehållet i textfilen.

Till exempel:

git commit --file commit_message.txt

När du kör kommandot ovan kommer git att använda filens innehåll som commit-meddelande.

Du kan också be git att öppna din standardredigerare för att skriva ett längre meddelande. Om du har miljövariabeln GIT_EDITOR eller EDITOR inställd, kommer git att öppna det programmet när du kör en blott git commit kommando.

Varför du bör skriva bra commit-meddelanden

Att skriva bra commit-meddelanden är avgörande för effektivt samarbete och kodunderhåll. Tydliga och beskrivande meddelanden underlättar förståelse, felsökning och kodgranskning. De kan till och med bidra till projektdokumentation eller release notes.

De möjliggör kunskapsdelning, smidig introduktion och supportversionskontroll. Prioritering av kvalitetsmeddelanden förbättrar utvecklingsprocesser och säkerställer kodbasens underhåll.