Suurendage oma Githubi mainet õigete Commit-sõnumitega

Selle asemel, et kirjutada üherealine git, tehke sõnumeid pühenduma -m Selles artiklis saate teada, kuidas kirjutada õigeid pühendumissõnumeid. Korralik pühendumissõnum on oluline, kuna see võimaldab teistel näha täpselt seda, mida olete muutnud, muutes teie projekti hõlpsamini jälgitavaks, suurendades teie kokkupuudet avatud lähtekoodiga kogukond.

Kirjutage õige pühendumissõnum

Selle asemel, et lisada käsu terminali käsk täitmise teade, avage oma lemmik tekstiredaktor tühja faili juurde. Sõnum peaks vastama järgmisele vormingule:

• Esimene rida on pealkiri, mis võtab kokku kogu pühenduse.
• Pärast tühja rida peaks järgmine rida või mitu rida olema mis tahes loetav kirjeldus, mis on vajalik sidumiseks. See võib olla nii kaua kui soovitud.
  instagram viewer
• Kõik järgmised read peaksid võtma kokku koodis sellises vormingus tehtud täpsed muudatused:
  • Failinimi: Rida # - muudatuse lühikirjeldus.

Näide Commit Message

Allpool on näidatud kohustuslik teade:

Lisatud Dockeri tugi, uus funktsioon is_unique ja veaparandus.
Lisatud tugi dokkija koostamiseks ja vajaduse korral värskendatud installijuhised. Lisas ka funktsiooni check_order () funktsiooni, et kontrollida unikaalsust, ja parandas väikest viga toote nälkjate loomisel.
src / somedir / library.py: 381 - lisati funktsiooni check_order () parameeter 'is_unique'.
src / products.py: 194 - Parandatud viga toote nälja loomisel.
docker-compose.yml - lisati fail docker-compose.
docs / install.md - uuendatud installijuhend, mis sisaldab Dockeri kaudu installimist.

Tee teade

Kohustusi tehes selle asemel, et kasutada -m kasutage--fail valik. Näiteks kui teie pühendumissõnumi failinimi on comm.txt, käivitate käsu:

git toime - fail pühendama.txt

See on kõik, mis seal on! Loodetavasti aitab see teil pakkuda oma jälgijatele rohkem standardiseeritud ja selgemaid pühendumissõnumeid, aidates teie projektil eksponeerida ja aidata avatud lähtekoodiga kogukond kasvab.

Pildikrediit: Caleb White /Unstrash