Matt Dizak
E-mailem

Chcete si vylepšit reputaci na GitHubu? Zde je návod, jak formátovat zprávy potvrzení.

Místo psaní jednořádkových zpráv git commit s spáchat -m Tato možnost se v tomto článku dozvíte, jak psát správné zprávy o odevzdání. Správné zprávy o odevzdání jsou důležité, protože ostatním umožňují vidět přesně to, co jste upravili, usnadníte ostatním váš projekt, aby pomohli zvýšit vaši expozici vůči otevřenému zdroji společenství.

Napište řádnou potvrzovací zprávu

Místo zahrnutí zprávy o potvrzení do příkazu terminálu otevřete svou oblíbenou textový editor do prázdného souboru. Zpráva by měla odpovídat následujícímu formátu:

nano vs. Vim: Nejlepší textové editory terminálu, ve srovnání

Hledáte textový editor terminálu pro Linux? Hlavní volba je mezi Vim a nano! Zde je jejich srovnání.

  • První řádek je nadpis se shrnutím celého odevzdání.
  • Za prázdným řádkem by měl být další řádek nebo několik řádků jakýkoli čitelný popis nezbytný pro potvrzení. Může to být tak dlouho, jak si přejete.
    • instagram viewer
  • Všechny následující řádky by měly shrnout přesné změny provedené v kódu v takovém formátu:
    • Název souboru: Řádek # - krátký popis modifikace.

Příklad potvrzení zprávy

Níže je uvedena ukázková zpráva potvrzení: 


Přidána podpora Dockeru, nová funkce is_unique a oprava chyby.
Přidána podpora pro docker-compose a podle potřeby aktualizované pokyny k instalaci. Zahrnuta také nová funkce ve funkci check_order () pro kontrolu jedinečnosti a opravená malá chyba při vytváření produktových slimáků.
src / somedir / library.py: 381 - Přidán parametr 'is_unique' do funkce check_order ().
src / products.py: 194 - Opravená chyba při vytváření produktu slimák.
docker-compose.yml - Přidán soubor docker-compose.
docs / install.md - Aktualizovaný průvodce instalací, který obsahuje informace o instalaci pomocí Dockeru.

Potvrdit zprávu

Při provádění potvrzení hned, místo použití -m zprávu, použijte--soubor volba. Například pokud je název vaší zprávy potvrzení potvrzení commit.txt, spustili byste příkaz: 

git commit --file commit.txt

To je vše! Doufejme, že vám to pomůže poskytnout standardizovanější a jasnější zprávy o potvrzení vašim následovníkům, pomůže to vašemu projektu získat větší pozornost a pomůže otevřený zdroj komunita roste.

Uznání obrázku: Caleb White /Unsplash

E-mailem
Jak vytvořit své první úložiště na Githubu

Chcete sdílet své vývojové projekty online? Zde je návod, jak začít s prvním úložištěm Github.

Související témata
  • Programování
  • GitHub
O autorovi
Matt Dizak (13 článků publikováno)Více od Matta Dizaka

Přihlaste se k odběru našeho zpravodaje

Připojte se k našemu zpravodaji s technickými tipy, recenzemi, bezplatnými elektronickými knihami a exkluzivními nabídkami!

Ještě jeden krok…!

V e-mailu, který jsme vám právě poslali, potvrďte svou e-mailovou adresu.

.