Matt Dizak
E-mail

Želite li poboljšati svoju reputaciju na GitHubu? Evo kako formatirati poruke predavanja.

Umjesto pisanja git-poruka u jednom retku s počiniti -m opcija, u ovom članku naučite kako napisati ispravne poruke urezivanja. Pravilna poruka urezivanja je važna, jer omogućuje drugima da vide točno što ste promijenili, olakšavajući vaš projekt drugima da prate povećavajući vašu izloženost otvorenom izvoru zajednica.

Napišite ispravnu poruku predavanja

Umjesto uključivanja poruke urezivanja u naredbu terminala, otvorite svoj omiljeni uređivač teksta u praznu datoteku. Poruka bi trebala odgovarati sljedećem formatu:

nano vs. Vim: Najbolji terminalski urednici teksta, u usporedbi

Tražite li terminalni editor teksta za Linux? Glavni izbor je između Vima i nano-a! Evo kako se uspoređuju.

  • Prvi redak je naslov, sažimajući cjelokupno predavanje.
  • Nakon praznog retka, sljedeći redak ili nekoliko redaka trebao bi biti bilo koji čitljiv opis potreban za urezivanje. To može trajati koliko god želite.
    • instagram viewer
  • Svi sljedeći redovi trebaju rezimirati točne promjene u kodu u takvom obliku:
    • Naziv datoteke: Redak # - Kratki opis izmjene.

Primjer poruke urezivanja

Ispod je primjer poruke urezivanja: 


Dodana je podrška za Docker, nova značajka is_unique, plus ispravka programskih pogrešaka.
Dodana podrška za docker-compose i ažurirane upute za instalaciju po potrebi. Također je uključio novu značajku unutar funkcije check_order () za provjeru jedinstvenosti i ispravio malu bug pri stvaranju puževa proizvoda.
src / somedir / library.py: 381 - Dodan je parametar 'is_unique' funkciji check_order ().
src / products.py: 194 - Ispravljena greška pri stvaranju puža proizvoda.
docker-compose.yml - Dodana datoteka docker-compose.
docs / install.md - Ažurirani vodič za instalaciju koji uključuje kako instalirati putem Dockera.

Objavi poruku

Kada se sada obvezujete, umjesto da koristite -m poruku, upotrijebite--datoteka opcija. Na primjer, ako je naziv datoteke vaše poruke urezivanja commit.txt, pokrenuli biste naredbu: 

git commit --file commit.txt

To je sve! Nadam se da će vam ovo pomoći da pružite standardizirane i jasnije poruke predavanja svojim sljedbenicima, pomažući vašem projektu da stekne izloženost i pomogne otvoreni izvor zajednica raste.

Zasluga za sliku: Caleb White /Rasprši

E-mail
Kako stvoriti svoje prvo spremište na Githubu

Želite podijeliti svoje razvojne projekte na mreži? Evo kako započeti s prvim spremištem Github.

Povezane teme
  • Programiranje
  • GitHub
O autoru
Matt Dizak (Objavljeno 13 članaka)Više od Matta Dizaka

Pretplatite se na naše obavijesti

Pridružite se našem biltenu za tehničke savjete, recenzije, besplatne e-knjige i ekskluzivne ponude!

Još jedan korak…!

Potvrdite svoju e-adresu u e-pošti koju smo vam upravo poslali.

.