Kuidas kirjutada tõhusat ja kasulikku Git Commit sõnumit

Kinnitussõnumid on versioonihaldussüsteemis, nagu Git, iga sissekande lühikirjeldus. Kui teete projektifailides muudatusi, peaksite esitama sõnumi, milles selgitatakse, mida nad teevad või miks te need tegite.

Kohustussõnumid toimivad dokumentatsiooni ja suhtluse vormina. Neil on oluline roll projekti selge ja organiseeritud versiooniajaloo säilitamisel. Õppige kirjutama häid pühendumissõnumeid ja teised teie meeskonnaliikmed hindavad teie tööd veelgi.

Hea pühendumise sõnumi struktuur

Hea näide kinnitusteate kohta sisaldab nelja jaotist: tüüp, kirjeldus, sisu ja jalus.

Nagu nii:

: 
[valikuline sisu]
[valikuline jalus]

Tüüp

Tüüp kirjeldab praeguses kohustuses tehtud muudatuse tüüpi. Võite kasutada mis tahes süsteemi, mis teie olukorrale sobib. Näiteks siin on mõned näidismärksõnad, mida saate kasutada igat tüüpi muudatustest märku andmiseks koos näidiskasutusega.

• feat: teie muudatustega kaasneb uus funktsioon.
• parandada: parandate vea.
• refaktor: teie muudatuse kood taastab ilma viga parandamata või uut funktsiooni lisamata.
• test: teete testimisega seotud muudatusi. Näiteks kui sa kirjuta Jestiga teste või mis tahes muu testimise raamistik valite.
• koristustöö: muudatused, mis ei ole seotud paranduse, funktsiooni või testiga. Näiteks sõltuvuste värskendamine.
• dok: kui värskendate dokumentatsiooni.
• stiilis: muudatused, mis ei mõjuta koodi tähendust, nt tühiku lisamine, puuduvad semikoolonid jne.
• perf: jõudluse parandamisega seotud muudatused.
• ehitada: kui teete muudatusi, mis mõjutavad ehitusfaile.
• ci: pideva integreerimisega seotud muudatused.
• tagasi pöörduma: naasmisel eelmisele kohustusele.

Kirjeldus

Kinnitussõnumi “kirjeldus” on sisutihe ja kirjeldav kokkuvõte kohustuses tehtud muudatustest. See toimib pealkirjana, mis kajastab kohustuse olemust.

Kirjeldust kirjutades pidage meeles järgmist:

• Tehke see piisavalt selgeks ja konkreetseks, et kohustust lühidalt kirjeldada.
• Tee see lühidalt ja ülevaatlikult. Ideaalis oleks kõige parem piirata seda kuni 50 tähemärgini.
• Kirjutage see olevikuvormis, isegi kui kirjeldate juba tehtud muudatusi.
• Kasutage seda kirjutades käskivat meeleolu.
• Alustage seda suure algustähega.
• Ärge lõpetage seda punktiga.

Näiteks:

feat: rakendage avalehe jaoks tumeda režiimi lüliti

See näide näitab, kuidas saate kirjutada sellise kohustuse kirjelduse rakendab tumedat režiimi. See kasutab feat tüüpi, sest see tutvustab uut funktsiooni.

Keha (valikuline)

Kinnitussõnumi põhiosa sisaldab täiendavaid üksikasju ja konteksti kinnistamises tehtud muudatuste kohta. Alati pole keha vaja, kuid see võib aidata anda rohkem teavet, selgitada muudatuse põhjendusi või kirjeldada tehnilisi kaalutlusi.

Kinnitussõnumi põhiosa kirjutamisel tasub tähele panna järgmist.

• Git ei murra teksti kunagi automaatselt, seega mähkige see keha kirjutamisel käsitsi 72 märgi pikkuseks. See annab Gitile piisavalt ruumi teksti taande tegemiseks, muutes selle loetavamaks.
• Kasutage kehaosa, et selgitada, mis muutusega juhtus, miks te muudatuse tegite ja muudatuse põhjuseid.
• Peate jätma kirjeldava rea ​​ja sisu vahele tühja rea. See võimaldab Gitil neil vahet teha.
• Kui sidumine toob kaasa mitu muudatust või mõjutab koodibaasi erinevaid piirkondi, kaaluge muudatuste jaotamiseks täppide või lõikude kasutamist. See parandab loetavust ja aitab lugejatel mõista kohustuse erinevaid aspekte.

Näiteks:

feat: lisage GitHub OAuthi pakkujaks
Sujuvuse võimaldamiseks integreerige GitHub OAuthi pakkujana 
autentimine GitHubi kontodega.
- Rakendage GitHubi API-ga OAuthi autentimisvoog
- Konfigureerige GitHubi autentimiseks vajalikud lõpp-punktid ja seaded
- Värskendage kasutajaliidest, et lisada GitHubi sisselogimisvõimalus

Ülaltoodud näide näitab head Giti sissekande sõnumit lisatava funktsiooni jaoks GitHub OAuthi pakkujana teie rakendusele. Sellel kinnitusteatel on kokkuvõtlik rida (50 tähemärki või vähem), üksikasjalikum selgitav tekst (umbes 72 tähemärgini) ja lisateabe jaoks täpppunktid.

Kinnitussõnumi jaluse sektsioon on valikuline osa, mis pakub kinnitamisega seotud lisateavet või metaandmeid. Tavaliselt asetatakse see kereosa järele, eraldatuna tühja joonega. Jalus võib sisaldada erinevat tüüpi teavet, näiteks viiteid seotud probleemidele, silte või erimärkusi.

Probleemidele, tõmbepäringutele või muudele seotud üksustele viitamisel kasutage oma projekti probleemide jälgimissüsteemi nõutavat süntaksit või vormingut. See tagab, et viited on õigesti tuvastatud ja lingitud.

Näiteks:

feat: lisage GitHub OAuthi pakkujaks
Sujuvuse võimaldamiseks integreerige GitHub OAuthi pakkujana 
autentimine GitHubi kontodega.
- Rakendage GitHubi API-ga OAuthi autentimisvoog
- Konfigureerige GitHubi autentimiseks vajalikud lõpp-punktid ja seaded
- Värskendage kasutajaliidest, et lisada GitHubi sisselogimisvõimalus
Lahendused: #123
Vaata ka: #456, #789

Jalus viitab seotud probleemile #123 ja mainib täiendava konteksti saamiseks muid seotud probleeme #456 ja #789.

Kinnitussõnumi lisamine

Kinnitussõnumeid saate kirjutada kasutades -m lipp, millele järgneb jutumärkides sissekandmise teade (valikuline, kuid soovitatav).

The -m lipp sobib ideaalselt lühikeste sissekandmisteadete jaoks, mis sisaldavad tavaliselt tüüpi ja kirjeldust.

Näiteks:

git commit -m "koristustöö: muuda linteriks ESlint"

Kui teie kinnitussõnum nõuab aga rohkem üksikasju (nt sisu ja jalus), on parem kirjutada täitmine tekstiredaktoris või IDE-s.

Teise võimalusena võite kirjutada pikad sissekandesõnumid tekstifaili ja kasutada --fail lipp, et määrata tekstifaili sisuks sissekandmise teated.

Näiteks:

git commit -- fail commit_message.txt

Kui käivitate ülaltoodud käsu, kasutab git kinnitussõnumina faili sisu.

Samuti saate pikema sõnumi kirjutamiseks käskida gitil avada vaikeredaktor. Kui teil on määratud keskkonnamuutuja GIT_EDITOR või EDITOR, avab git selle programmi, kui käivitate palja git commit käsk.

Miks peaksite kirjutama häid pühendumissõnumeid

Heade sidumissõnumite kirjutamine on tõhusa koostöö ja koodide hooldamise jaoks ülioluline. Selged ja kirjeldavad sõnumid aitavad mõista, siluda ja koodi üle vaadata. Nad võivad isegi kaasa aidata projekti dokumentatsioonile või väljalaskemärkmetele.

Need võimaldavad teadmiste jagamist, sujuvat liitumist ja toetavad versioonikontrolli. Kvaliteetsete kinnitussõnumite eelistamine parandab arendusprotsesse ja tagab koodibaasi hooldatavuse.