Git Commit Message: Best Practices

Git Commit Message Best Practices



A fejlesztés során nagyon fontos a kommunikáció más emberekkel a projektek áttekintése és megértése érdekében. A Gitnek azonban üzenetre van szüksége az elkötelezettséghez. Ez a legjobb módja a véglegesítési üzenet különféle részleteinek megadására. Leírja, hogy a felhasználók mit módosítottak a projektben. Különösen fontos, hogy jó, könnyen olvasható és érthető üzenetet írjon. Nem számít, hogy helyi vagy távoli projektről van szó.

Ez a bejegyzés a következőkre terjed ki:







Mi az a Git Commit üzenet?

A Git commit üzenet rövid magyarázata annak a módosításnak, amelyet egy adott időpontban egy Git tárhelyen hajtottak végre. Ez a fejlesztő által végrehajtott változtatások feljegyzése, beleértve a kódmódosításokat, kiegészítéseket és törléseket.



Amikor a felhasználók módosítják a kódjukat, a „ git add ” parancsot. Miután az összes változtatást végrehajtották, minden változtatást végre kell hajtani. Ebből a célból hajtsa végre a „git commit” parancsot. Minden véglegesítéshez szükség van egy véglegesítési üzenetre, amely leírja, hogy milyen változtatásokat hajtottak végre a véglegesítésben.



A Git Commit üzenetek legjobb gyakorlatai

Számos gyakorlat létezik a Git commit üzenetekre. Néhányat az alábbiakban sorolunk fel:





  • A kötelezettségvállalási üzenet legyen rövid és érthető.
  • Az üzenetnek 40 karakternél rövidebbnek kell lennie, és össze kell foglalnia a módosításokat.
  • Mindig kezdje az üzenetet egy lenyűgöző igével, például ' Hozzáadás”, „Javítás”, „Frissítés” „Törlés ” és még sok más, amely egyértelművé és tömörsé teszi az üzenetet.
  • A felhasználók az összes véglegesítést listában vagy felsorolásban is megjelölhetik.
  • A véglegesítési üzenet szövegében rövid magyarázatot adjon meg arról, hogy miért hajtották végre a változtatásokat. Segíthet másoknak megérteni a változások mögött rejlő okokat.
  • Mindig válassza el a témát és a törzset üres vonallal. Ez javítja az olvashatóságot, és segít megkülönböztetni az összefoglalót a részletektől.
  • Használja ugyanazt a formázást és stílust a projektben lévő összes véglegesítési üzenethez.
  • Mindig használd a helyes helyesírást és nyelvtant.
  • A világos és helyes nyelvezet javítja az üzenet olvashatóságát és professzionalizmusát.

Hogyan lehet üzeneteket véglegesíteni a Gitben?

Üzenet rögzítéséhez a Gitben kövesse az alábbi utasításokat:

  • Átirányítás a kívánt tárhelyre.
  • Fájl létrehozása vagy frissítése.
  • Változások nyomon követése a színpadi területen.
  • Használja a „git commit” parancsot a „-m” jelzővel a véglegesítési üzenethez.

1. lépés: Lépjen a Local Git Directoryhoz

Kezdetben indítsa el a Git Bash terminált a rendszeren, és navigáljon a kívánt helyi tárolóhoz a „ CD 'parancs:



CD 'C:\Users\user\Git\projectrepo'

2. lépés: Tekintse meg a Git állapotát

Hajtsa végre a „ git állapot ” parancs az aktuális működési állapot ellenőrzéséhez:

git állapot

Az eredményül kapott kép azt mutatja, hogy a munkaterület tiszta, és nincs semmi kötelezettség:

3. lépés: Fájlok létrehozása

Hozzon létre egy fájlt a munkaterületen a „touch” parancs futtatásával a fájlnévvel együtt:

érintés f3.txt

4. lépés: Adjon hozzá nyomon nem követett fájlokat az átmeneti területen

Használja a következő parancsot a munkaterületről az átmeneti területre történő változások nyomon követésére:

git add f3.txt

5. lépés: Ellenőrizze a követett fájlt

Ezután futtassa az alábbi parancsot, hogy ellenőrizze, hogy a változtatásokat követték-e vagy sem:

git állapot

Észrevehető, hogy a fájl sikeresen hozzáadásra került az átmeneti területhez:

6. lépés: Végezze el az üzenetet

Végezze el az összes változtatást a „ git commit 'parancs:

git commit

Az alábbi kimenet a megadott szerkesztőnevet jelzi ' COMMIT_EDITNSG ” megnyílt. Szúrjon be egy véglegesítési üzenetet az összes módosítás véglegesítéséhez:

A véglegesítési üzenet beszúrása után mentse el a változtatásokat a „ CTRL+S ” és a szerkesztő bezárása. Ennek eredményeként az összes változtatást sikeresen végrehajtották:

Ezenkívül megadhatja az üzenetet a „ git commit ' parancs a ' segítségével -m ” zászlót. Alábbiak szerint:

git commit -m 'a változások nyomon követve'

Az alábbi eredmény szerint az összes változtatást végrehajtották:

A Git üzenetéről és a bevált gyakorlatokról ennyi.

Következtetés

A Git véglegesítési üzenet egy adott időpontban a Git-lerakaton végrehajtott módosítás rövid leírása. Néhány fontos szempontot szem előtt kell tartania a véglegesítési üzenet megírásakor, például, hogy a véglegesítési üzenet legyen rövid és érthető. Ezenkívül az üzenetnek 40 karakternél rövidebbnek kell lennie, és össze kell foglalnia a módosításokat. Ez a bejegyzés mindent leírt a Git commits üzenetről és annak bevált gyakorlatairól.