Git hjælper forskellige, distribuerede teams med at arbejde på en samlet kodebase. Med denne magt følger et ansvar: at efterlade gode beskrivelser af dine ændringer.

Commit-beskeder er korte beskrivelser af hver commit i et versionskontrolsystem som Git. Når du foretager ændringer til dine projektfiler, bør du give en besked, der forklarer, hvad de gør, eller hvorfor du lavede dem.

Commit-meddelelser fungerer som en form for dokumentation og kommunikation. De spiller en afgørende rolle i at opretholde en klar og organiseret versionshistorie af et projekt. Lær, hvordan du skriver gode forpligtelsesbeskeder, og de andre medlemmer af dit team vil sætte endnu mere pris på dit arbejde.

Strukturen af ​​et godt forpligtelsesbudskab

Et godt eksempel på en commit-meddelelse omfatter fire sektioner: Type, Description, Body og Footer.

Ligesom:

: 
[valgfri tekst]
[valgfri sidefod]

Type

Typen beskriver den type ændring, der er foretaget i den nuværende commit. Du kan bruge et hvilket som helst system, der giver mening for dine omstændigheder. For eksempel er her nogle eksempler på søgeord, du kan bruge til at signalere hver type ændring, sammen med eksempelbrug:

instagram viewer

  • bedrift: dine ændringer introducerer en ny funktion.
  • rette op: du retter en fejl.
  • refaktor: din ændring af refactors-kode uden at rette en fejl eller tilføje en ny funktion.
  • prøve: du foretager eventuelle testrelaterede ændringer. For eksempel når du skrive test med Jest eller nogen anden testramme du vælger.
  • sur pligt: ændringer, der ikke er relateret til en rettelse, funktion eller test. For eksempel opdatering af afhængigheder.
  • dokumenter: når du opdaterer dokumentation.
  • stil: ændringer, der ikke påvirker betydningen af ​​koden, såsom tilføjelse af mellemrum, manglende semikolon osv.
  • perf: ændringer relateret til præstationsforbedringer.
  • bygge: når du foretager ændringer, der påvirker build-filerne.
  • ci: ændringer relateret til kontinuerlig integration.
  • vende tilbage: når du vender tilbage til en tidligere commit.

Beskrivelse

"Beskrivelsen" af en commit-besked er en kortfattet og beskrivende oversigt over de ændringer, der er foretaget i commit. Den fungerer som en overskrift, der fanger essensen af ​​forpligtelsen.

Når du skriver beskrivelsen, skal du huske på følgende:

  • Gør det klart og specifikt nok til at beskrive forpligtelsen med et øjeblik.
  • Gør det kort og præcist. Ideelt set ville det være bedst at begrænse det til 50 tegn eller mindre.
  • Skriv det i nutid, selvom du beskriver ændringer, der allerede er foretaget.
  • Gør brug af den imperative stemning, mens du skriver den.
  • Start det med et stort bogstav.
  • Slut det ikke med en periode.

For eksempel:

feat: Implementer mørk tilstandsskift til startsiden

Dette eksempel viser, hvordan du kan skrive beskrivelsen for en forpligtelse implementerer mørk tilstand. Den bruger bedrift type, fordi den introducerer en ny funktion.

Body (valgfrit)

Brødtekstdelen af ​​en commit-besked giver yderligere detaljer og kontekst om de ændringer, der er foretaget i commit. Du har ikke altid brug for en krop, men den kan hjælpe med at give flere oplysninger, forklare en ændrings begrundelse eller beskrive eventuelle tekniske overvejelser.

Her er nogle ting, du skal bemærke, når du skriver brødtekstdelen af ​​en forpligtelsesbesked:

  • Git ombryder aldrig tekst automatisk, så ombryd den manuelt med 72 tegn, når du skriver brødteksten. Dette giver Git plads nok til at indrykke tekst, hvilket gør den mere læsbar.
  • Brug kroppen til at forklare, hvad der skete i ændringen, hvorfor du lavede ændringen, og ræsonnementet bag din ændring.
  • Du skal efterlade en tom linje mellem beskrivelseslinjen og brødteksten. Dette giver Git mulighed for at skelne mellem dem.
  • Hvis commit introducerer flere ændringer eller påvirker forskellige områder af kodebasen, kan du overveje at bruge punktopstillinger eller afsnit til at nedbryde ændringerne. Dette forbedrer læsbarheden og hjælper læserne med at forstå de forskellige aspekter af forpligtelsen.

For eksempel:

feat: Tilføj GitHub som en OAuth-udbyder
Integrer GitHub som en OAuth-udbyder for at muliggøre problemfri 
godkendelse med GitHub-konti.


- Implementer OAuth-godkendelsesflow med GitHub API
- Konfigurer nødvendige slutpunkter og indstillinger for GitHub-godkendelse
- Opdater brugergrænsefladen til at inkludere GitHub-loginmulighed

Eksemplet ovenfor viser en god Git commit besked for en funktion, der tilføjer GitHub som OAuth-udbyder til din ansøgning. Denne commit-besked har en kortfattet opsummeringslinje (50 tegn eller mindre), en mere detaljeret forklarende tekst (ombrudt til ca. 72 tegn) og punkttegn for yderligere information.

Sidefodssektionen i en commit-meddelelse er en valgfri del, der giver yderligere information eller metadata relateret til commit. Det er typisk placeret efter kropssektionen, adskilt af en blank linje. Sidefoden kan indeholde forskellige typer information, såsom referencer til relaterede problemer, tags eller særlige bemærkninger.

Når du refererer til problemer, pull-anmodninger eller andre relaterede emner, skal du bruge den relevante syntaks eller format, der kræves af dit projekts problemsporingssystem. Dette sikrer, at referencerne er korrekt genkendt og forbundet.

For eksempel:

feat: Tilføj GitHub som OAuth-udbyder
Integrer GitHub som en OAuth-udbyder for at muliggøre problemfri 
godkendelse med GitHub-konti.


- Implementer OAuth-godkendelsesflow med GitHub API
- Konfigurer nødvendige slutpunkter og indstillinger for GitHub-godkendelse
- Opdater brugergrænsefladen til at inkludere GitHub-loginmulighed
Løser: #123
Se også: #456, #789

Sidefoden refererer til det relaterede emne #123 og nævner andre relaterede emner #456 og #789 for yderligere kontekst.

Tilføjelse af Commit Message

Du kan skrive commit-beskeder ved hjælp af -m flag efterfulgt af commit-meddelelsen i anførselstegn (valgfrit, men anbefales).

Det -m flag er ideel til korte commit-beskeder, som regel inklusive type og beskrivelse.

For eksempel:

git commit -m "jore: Skift linter til ESlint"

Men når din commit-besked kræver flere detaljer, såsom en brødtekst og en sidefod, ville du være bedre stillet at skrive commit i en teksteditor eller IDE.

Alternativt kan du skrive lange commit-beskeder i en tekstfil og bruge --fil flag for at angive commit-meddelelserne som indholdet af tekstfilen.

For eksempel:

git commit --fil commit_message.txt

Når du kører kommandoen ovenfor, vil git bruge filens indhold som commit-meddelelsen.

Du kan også bede git om at åbne din standardeditor for at skrive en længere besked. Hvis du har GIT_EDITOR eller EDITOR miljøvariablen indstillet, vil git åbne det program, når du kører en bare git commit kommando.

Hvorfor du skal skrive gode forpligtelsesbeskeder

At skrive gode commit-beskeder er afgørende for effektivt samarbejde og kodevedligeholdelse. Klare og beskrivende beskeder hjælper med forståelse, fejlretning og kodegennemgang. De kan endda bidrage til projektdokumentation eller release notes.

De muliggør vidensdeling, glat onboarding og understøtter versionskontrol. Prioritering af kvalitetsforpligtelsesbudskaber forbedrer udviklingsprocesser og sikrer kodebasevedligeholdelse.