Git Commit Message: Best Practices

Git Commit Message Best Practices



Při vývoji je poměrně důležitá komunikace s ostatními lidmi za účelem kontroly a porozumění projektu. Git však vyžaduje zprávu k potvrzení. Je to nejlepší způsob, jak specifikovat různé podrobnosti o zprávě odevzdání. Popisuje, co uživatelé v projektu upravili. Zejména je důležité napsat dobrou zprávu o odevzdání, která je snadno čitelná a srozumitelná. Nezáleží na tom, zda se jedná o lokální nebo vzdálený projekt.

Tento příspěvek se bude týkat následujících témat:







Co je Git Commit Message?

Zpráva potvrzení Git je stručným vysvětlením úpravy, která byla provedena v úložišti Git v určitém okamžiku. Je to záznam změn provedených vývojářem, včetně úprav kódu, přidání a odstranění.



Když uživatelé změní svůj kód, uspořádají je pomocí „ git přidat “příkaz. Jakmile jsou všechny změny zinscenovány, musí provést všechny změny. Za tímto účelem spusťte příkaz „git commit“. Pro každý odevzdání je vyžadována zpráva o odevzdání a měla by popisovat, jaké změny byly v odevzdání provedeny.



Osvědčené postupy pro Git Commit Messages

Existuje velké množství postupů pro zprávy odevzdání Git. Některé z nich jsou uvedeny níže:





  • Udržujte zprávu o odevzdání krátké a srozumitelné.
  • Zpráva by měla mít méně než 40 znaků a měla by obsahovat shrnutí úprav.
  • Vždy začněte zprávu působivým slovesem, například „ Přidat, Opravit, Aktualizovat, Odstranit “ a mnoho dalších, které činí sdělení jasným a stručným.
  • Uživatelé mohou ukázat všechny odevzdání ve formě seznamu nebo odrážek.
  • V těle zprávy potvrzení uveďte stručné vysvětlení, proč byly změny provedeny. Může pomoci ostatním pochopit důvody změn.
  • Vždy rozdělte předmět a tělo prázdným řádkem. To zlepšuje čitelnost a pomáhá odlišit souhrn od podrobností.
  • Použijte stejné formátování a styl pro všechny zprávy odevzdání v projektu.
  • Vždy používejte správný pravopis a gramatiku.
  • Jasný a správný jazyk zlepšuje čitelnost a profesionalitu sdělení.

Jak odesílat zprávy v Gitu?

Chcete-li odeslat zprávu v Gitu, postupujte podle níže uvedených pokynů:

  • Přesměrujte na požadované úložiště.
  • Vytvořte nebo aktualizujte soubor.
  • Sledujte změny ve zkušební oblasti.
  • Pro zprávu odevzdání použijte příkaz „git commit“ s příznakem „-m“.

Krok 1: Přejděte do místního adresáře Git

Nejprve spusťte terminál Git Bash na vašem systému a přejděte do požadovaného místního úložiště pomocí „ CD 'příkaz:



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

Krok 2: Zobrazte stav Git

Proveďte „ stav git ” příkaz pro kontrolu aktuálního pracovního stavu:

stav git

Výsledný obrázek ukazuje, že pracovní plocha je čistá a není co dělat:

Krok 3: Vygenerujte soubory

Vytvořte soubor v pracovní oblasti spuštěním příkazu „touch“ spolu s názvem souboru:

dotek f3.txt

Krok 4: Přidejte nesledované soubory do pracovní oblasti

Ke sledování změn z pracovní oblasti do pracovní oblasti použijte následující příkaz:

git přidat f3.txt

Krok 5: Ověřte sledovaný soubor

Dále spusťte níže uvedený příkaz a zkontrolujte, zda byly změny sledovány nebo ne:

stav git

Můžete si všimnout, že soubor byl úspěšně přidán do pracovní oblasti:

Krok 6: Potvrdit zprávu

Proveďte všechny změny pomocí „ git commit 'příkaz:

git commit

Níže uvedený výstup označuje zadaný název editoru “ COMMIT_EDITNSG ' byl otevřen. Vložte zprávu odevzdání pro potvrzení všech změn:

Po vložení zprávy odevzdání uložte změny stisknutím tlačítka „ CTRL+S “ a zavřete editor. V důsledku toho byly všechny změny úspěšně provedeny:

Kromě toho můžete také specifikovat zprávu spolu s „ git commit 'příkaz s pomocí ' -m “vlajka. Jak následuje:

git commit -m 'změny byly sledovány'

Níže uvedený výstup uvedl, že byly provedeny všechny změny:

To je vše o zprávě závazku Git a osvědčených postupech pro ni.

Závěr

Zpráva potvrzení Git je stručný popis úpravy, která byla provedena v úložišti Git v určitém okamžiku. Při psaní zprávy o odevzdání je nutné mít na paměti některé důležité body, jako je například to, aby zpráva byla krátká a srozumitelná. Dále by zpráva měla mít méně než 40 znaků a měla by shrnout úpravy. Tento příspěvek popsal vše o zprávě potvrzení Git a jejích osvědčených postupech.