Git Commit Message: Best Practices

Pri vývoji je dosť dôležitá komunikácia s ostatnými ľuďmi za účelom hodnotenia a porozumenia projektu. Git však vyžaduje správu na potvrdenie. Je to najlepší spôsob, ako špecifikovať rôzne podrobnosti o správe odovzdania. Popisuje, čo používatelia v projekte upravili. Predovšetkým je dôležité napísať dobrú správu o odovzdaní, ktorá je ľahko čitateľná a zrozumiteľná. Nezáleží na tom, či ide o lokálny alebo vzdialený projekt.

Tento príspevok sa bude týkať nasledujúcich oblastí:

• Čo je správa Git Commit?
• Osvedčené postupy pre Git Commit Messages
• Ako posielať správy v Git?

Čo je správa Git Commit?

Správa potvrdenia Git je krátkym vysvetlením modifikácie, ktorá bola vykonaná v úložisku Git v konkrétnom čase. Je to záznam zmien, ktoré vykonal vývojár, vrátane úprav kódu, pridania a vymazania.

Keď používatelia zmenia svoj kód, naplánujú ich pomocou „ git pridať “príkaz. Keď sú všetky zmeny zinscenované, potom musia vykonať všetky zmeny. Na tento účel vykonajte príkaz „git commit“. Správa o odovzdaní sa vyžaduje pre každé odovzdanie a mala by popisovať, aké zmeny boli vykonané v odovzdaní.

Osvedčené postupy pre Git Commit Messages

Existuje veľké množstvo postupov pre správy odovzdania Git. Niektoré z nich sú uvedené nižšie:

• Správa o odovzdaní musí byť krátka a zrozumiteľná.
• Správa by mala mať menej ako 40 znakov a mala by obsahovať súhrn úprav.
• Správu vždy začnite pôsobivým slovesom, ako napríklad „ Pridať“, „Opraviť“, „Aktualizovať“ „Vymazať “ a mnoho ďalších, vďaka ktorým je posolstvo jasné a výstižné.
• Používatelia môžu označiť všetky odovzdania vo forme zoznamu alebo odrážok.
• Do tela správy potvrdenia zahrňte krátke vysvetlenie, prečo boli zmeny vykonané. Môže to pomôcť ostatným pochopiť dôvod zmien.
• Vždy oddeľte predmet a telo prázdnym riadkom. To zlepšuje čitateľnosť a pomáha rozlíšiť súhrn od detailov.
• Využite rovnaké formátovanie a štýl pre všetky správy odovzdania v projekte.
• Vždy používajte správny pravopis a gramatiku.
• Jasný a správny jazyk zlepšuje čitateľnosť a profesionalitu správy.

Ako posielať správy v Git?

Ak chcete odoslať správu v Git, postupujte podľa nižšie uvedených pokynov:

• Presmerujte na požadované úložisko.
• Vytvorte alebo aktualizujte súbor.
• Sledujte zmeny v pracovnej oblasti.
• Použite príkaz „git commit“ s príznakom „-m“ pre správu odovzdania v ňom.

Krok 1: Prejdite do adresára Local Git

Najprv spustite terminál Git Bash vo svojom systéme a prejdite do požadovaného lokálneho úložiska pomocou „ cd 'príkaz:

Krok 2: Pozrite si stav Git

Vykonajte „ stav git ” príkaz na kontrolu aktuálneho pracovného stavu:

Výsledný obrázok ukazuje, že pracovná plocha je čistá a nie je čo robiť:

Krok 3: Generovanie súborov

Vytvorte súbor v pracovnej oblasti spustením príkazu „touch“ spolu s názvom súboru:

Krok 4: Pridajte nesledované súbory do pracovnej oblasti

Na sledovanie zmien z pracovnej oblasti do pracovnej oblasti použite nasledujúci príkaz:

Krok 5: Overte sledovaný súbor

Potom spustite príkaz uvedený nižšie a skontrolujte, či boli zmeny sledované alebo nie:

Môžete si všimnúť, že súbor bol úspešne pridaný do pracovnej oblasti:

Krok 6: Odovzdajte správu

Vykonajte všetky zmeny pomocou „ git commit 'príkaz:

Nižšie uvedený výstup označuje zadaný názov editora “ COMMIT_EDITNSG “ bol otvorený. Vložte správu o odovzdaní na potvrdenie všetkých zmien:

Po vložení správy o odovzdaní uložte zmeny stlačením tlačidla „ CTRL+S “ a zatvorte editor. Výsledkom je, že všetky zmeny boli úspešne vykonané:

Okrem toho môžete tiež špecifikovať správu spolu s „ git commit “ pomocou príkazu “ -m “vlajka. Nasledovne:

Nižšie uvedený výstup uvádza, že všetky zmeny boli vykonané:

To je všetko o správe záväzkov Git a osvedčených postupoch pre ňu.

Záver

Správa potvrdenia Git je stručný popis úpravy, ktorá bola vykonaná v úložisku Git v konkrétnom čase. Pri písaní správy odovzdania je potrebné mať na pamäti niektoré dôležité body, ako je napríklad to, aby správa bola krátka a zrozumiteľná. Okrem toho by správa mala mať menej ako 40 znakov a mala by zhrnúť úpravy. Tento príspevok popisuje všetko o správe potvrdenia Git a jej osvedčených postupoch.