Matt Dizak
E-naslov

Želite izboljšati svoj ugled na GitHubu? Tukaj je opisano, kako formatirati sporočila o predaji

Namesto pisanja enovrstnih sporočil git commit z zaveži -m V tem članku se naučite, kako pravilno napisati sporočila za objavo. Pravilna sporočila o zavezah so pomembna, saj drugim omogočajo, da vidijo natančno, kaj ste spremenili, olajšanje vašega projekta drugim, s čimer boste povečali izpostavljenost odprtokodnemu viru skupnosti.

Napišite pravilno sporočilo o prevzemu

Namesto da vključite sporočilo za prevzem v ukaz terminala, odprite svojo priljubljeno urejevalnik besedil v prazno datoteko. Sporočilo mora biti v naslednji obliki:

nano vs. Vim: Primerjani najboljši urejevalniki besedil na terminalu

Iščete terminalski urejevalnik besedila za Linux? Glavna izbira je med Vim in nano! Evo, kako se primerjajo.

  • Prva vrstica je naslov, ki povzema celoten prevzem.
  • Po prazni vrstici mora biti naslednja vrstica ali več vrstic kakršen koli berljiv opis, potreben za objavo. To je lahko tako dolgo, kot želite.
    • instagram viewer
  • Vse naslednje vrstice morajo povzeti natančne spremembe kode v taki obliki:
    • Ime datoteke: Vrstica # - Kratek opis spremembe.

Primer sporočila za objavo

Spodaj je prikazano primer sporočila o objavi: 


Dodana podpora za Docker, nova funkcija is_unique in odprava napak.
Dodana podpora za docker-compose in po potrebi posodobljena navodila za namestitev. Vključil je tudi novo funkcijo funkcije check_order () za preverjanje edinstvenosti in odpravil majhno napako pri ustvarjanju polžev izdelkov.
src / somedir / library.py: 381 - Funkciji check_order () je dodan parameter 'is_unique'.
src / products.py: 194 - Odpravljena napaka pri ustvarjanju polža izdelka.
docker-compose.yml - dodana datoteka docker-compose.
docs / install.md - posodobljen priročnik za namestitev, ki vključuje namestitev prek Dockerja.

Sporočilo za objavo

Ko se zavežete zdaj, namesto da uporabite -m sporočilo, uporabite--mapa možnost. Če je na primer ime datoteke v vašem sporočilu za urejanje commit.txt, zaženite ukaz: 

git commit --file commit.txt

To je vse! Upajmo, da vam to pomaga, da svojim sledilcem posredujete bolj standardizirana in jasna sporočila o zavezah, kar pomaga vašemu projektu, da postane izpostavljen in pomaga odprtokodno skupnosti rastejo.

Zasluga za sliko: Caleb White /Unsplash

E-naslov
Kako ustvariti prvo skladišče na Githubu

Želite svoje razvojne projekte deliti po spletu? Evo, kako začeti s svojim prvim skladiščem Github.

Sorodne teme
  • Programiranje
  • GitHub
O avtorju
Matt Dizak (13 objavljenih člankov)Več od Matta Dizaka

Naročite se na naše novice

Pridružite se našemu glasilu za tehnične nasvete, preglede, brezplačne e-knjige in ekskluzivne ponudbe!

Še en korak…!

Potrdite svoj e-poštni naslov v e-poštnem sporočilu, ki smo vam ga pravkar poslali.

.