Hogyan írjunk hatékony, hasznos Git Commit üzenetet

A véglegesítési üzenetek az egyes véglegesítések rövid leírásai egy verziókezelő rendszerben, például a Gitben. Amikor változtatásokat hajt végre a projektfájlokon, küldjön egy üzenetet, amelyben elmagyarázza, mit csinálnak, vagy miért hajtotta végre azokat.

A kötelezettségvállalási üzenetek a dokumentáció és a kommunikáció egyik formájaként szolgálnak. Döntő szerepet játszanak a projekt egyértelmű és szervezett verziótörténetének fenntartásában. Tanuld meg, hogyan írj jó commit üzeneteket, és csapatod többi tagja még jobban értékelni fogja a munkádat.

A jó elkötelezettség üzenetének szerkezete

A véglegesítési üzenet jó példája négy részből áll: Típus, Leírás, Törzs és Lábléc.

Például így:

: 
[nem kötelező törzs]
[nem kötelező lábléc]

típus

A típus a jelenlegi véglegesítés során végrehajtott változtatások fajtáját írja le. Bármilyen rendszert használhat, amely az Ön körülményeinek megfelelő. Íme például néhány példakulcsszó, amellyel jelezheti az egyes változásokat, a példahasználat mellett:

• feat: módosításai új funkciót vezetnek be.
• javítani: hibát javítasz.
• refaktor: a módosítási kódot hibajavítás vagy új funkció hozzáadása nélkül módosítja.
• teszt: bármilyen teszteléssel kapcsolatos módosítást végrehajt. Például amikor Ön írj teszteket Jesttel vagy bármi egyéb tesztelési keretrendszer te választasz.
• házimunka: javításhoz, szolgáltatáshoz vagy teszthez nem kapcsolódó változtatások. Például a függőségek frissítése.
• dok: amikor frissíti a dokumentációt.
• stílus: olyan változtatások, amelyek nem befolyásolják a kód jelentését, például szóköz hozzáadása, hiányzó pontosvessző stb.
• perf: a teljesítmény javításával kapcsolatos változások.
• épít: amikor olyan változtatásokat hajt végre, amelyek hatással vannak az összeállítási fájlokra.
• ci: a folyamatos integrációval kapcsolatos változások.
• visszaszáll: az előző véglegesítéshez való visszatéréskor.

Leírás

A commit üzenet „leírása” a véglegesítésben végrehajtott változtatások tömör és leíró összefoglalása. Címként szolgál, amely megragadja a kötelezettségvállalás lényegét.

A leírás írásakor tartsa szem előtt a következőket:

• Legyen elég világos és konkrét ahhoz, hogy egy pillantással leírja a kötelezettségvállalást.
• Legyen rövid és tömör. Ideális esetben az lenne a legjobb, ha legfeljebb 50 karakterre korlátozná.
• Írja jelen időben, még akkor is, ha már végrehajtott változtatásokat ír le.
• Írás közben használja a felszólító módot.
• Kezdje nagybetűvel.
• Ne fejezd be ponttal.

Például:

feat: A sötét mód kapcsolójának alkalmazása a kezdőlaphoz

Ez a példa bemutatja, hogyan írhatja meg a leírást egy olyan véglegesítéshez sötét módot valósít meg. Használja a feat írja be, mert új funkciót vezet be.

Törzs (opcionális)

A véglegesítési üzenet törzsrésze további részleteket és kontextust tartalmaz a véglegesítés során végrehajtott változtatásokról. Nem mindig lesz szüksége testre, de segíthet több információval, magyarázattal szolgálni a változtatás indoklására vagy bármilyen technikai megfontolás leírására.

Íme néhány dolog, amit érdemes megjegyezni a véglegesítési üzenet törzsrészének írásakor:

• A Git soha nem tördeli automatikusan a szöveget, ezért manuálisan tördelje 72 karakterre a törzs írásakor. Ez elegendő teret biztosít a Gitnek a szöveg behúzására, így olvashatóbbá válik.
• Használja a testet, hogy magyarázza el, mi történt a változásban, miért hajtotta végre a változtatást, és magyarázza el a változtatás okait.
• Hagyjon üres sort a leírás és a szöveg között. Ez lehetővé teszi a Git számára, hogy különbséget tudjon tenni közöttük.
• Ha a véglegesítés több módosítást vezet be, vagy a kódbázis különböző területeit érinti, fontolja meg felsoroláspontok vagy bekezdések használatát a módosítások lebontásához. Ez javítja az olvashatóságot, és segít az olvasóknak megérteni a kötelezettségvállalás különböző aspektusait.

Például:

feat: Adja hozzá a GitHubot OAuth-szolgáltatóként
Integrálja a GitHub-ot OAuth-szolgáltatóként a zökkenőmentes működés érdekében 
hitelesítés GitHub-fiókokkal.
- Az OAuth hitelesítési folyamat megvalósítása a GitHub API-val
- Konfigurálja a GitHub hitelesítéshez szükséges végpontokat és beállításokat
- Frissítse a felhasználói felületet a GitHub bejelentkezési lehetőséggel

A fenti példa egy jó Git véglegesítési üzenetet mutat be egy hozzáadott szolgáltatáshoz A GitHub OAuth-szolgáltatóként az alkalmazásodhoz. Ez a véglegesítési üzenet tömör összefoglaló sort (legfeljebb 50 karakter), részletesebb magyarázó szöveget (körülbelül 72 karakterre csomagolva) és felsorolásjeleket tartalmaz a további információkért.

A véglegesítési üzenetben a lábléc egy opcionális rész, amely a véglegesítéshez kapcsolódó további információkat vagy metaadatokat biztosít. Jellemzően a karosszériarész után kerül elhelyezésre, üres vonallal elválasztva. A lábléc különféle típusú információkat tartalmazhat, például hivatkozásokat a kapcsolódó problémákra, címkéket vagy speciális megjegyzéseket.

A problémákra, a lehívási kérelmekre vagy más kapcsolódó elemekre hivatkozva használja a projekt problémakövető rendszere által megkövetelt megfelelő szintaxist vagy formátumot. Ez biztosítja a hivatkozások megfelelő felismerését és összekapcsolását.

Például:

feat: Adja hozzá a GitHubot OAuth-szolgáltatóként
Integrálja a GitHub-ot OAuth-szolgáltatóként a zökkenőmentes működés érdekében 
hitelesítés GitHub-fiókokkal.
- Az OAuth hitelesítési folyamat megvalósítása a GitHub API-val
- Konfigurálja a GitHub hitelesítéshez szükséges végpontokat és beállításokat
- Frissítse a felhasználói felületet a GitHub bejelentkezési lehetőséggel
Megoldások: #123
Lásd még: #456, #789

A lábléc a kapcsolódó 123-as problémára hivatkozik, és további kontextusként említi a 456-os és a 789-es kapcsolódó problémákat.

A véglegesítési üzenet hozzáadása

Végrehajtási üzeneteket írhat a -m zászló, majd a véglegesítési üzenet idézőjelek között (nem kötelező, de ajánlott).

A -m A flag ideális a rövid véglegesítési üzenetekhez, általában a típussal és a leírással együtt.

Például:

git commit -m "chore: Linter módosítása ESlint-re"

Ha azonban a véglegesítési üzenet több részletet igényel, például törzset és láblécet, jobb, ha a véglegesítést szövegszerkesztőben vagy IDE-ben írja meg.

Alternatív megoldásként hosszú véglegesítési üzeneteket írhat szöveges fájlba, és használhatja a --fájl jelölje be a véglegesítési üzenetek megadásához a szöveges fájl tartalmaként.

Például:

git commit --file commit_message.txt

A fenti parancs futtatásakor a git a fájl tartalmát fogja használni véglegesítési üzenetként.

Azt is megmondhatja a git-nek, hogy hosszabb üzenet írásához nyissa meg az alapértelmezett szerkesztőt. Ha a GIT_EDITOR vagy az EDITOR környezeti változó be van állítva, a git megnyitja azt a programot, amikor egy üres git commit parancs.

Miért érdemes jó elkötelezettségű üzeneteket írni

A jó véglegesítési üzenetek írása elengedhetetlen a hatékony együttműködéshez és a kód karbantartásához. A világos és leíró üzenetek segítik a megértést, a hibakeresést és a kódellenőrzést. Még a projektdokumentációhoz vagy a kiadási megjegyzésekhez is hozzájárulhatnak.

Lehetővé teszik a tudásmegosztást, a zökkenőmentes beépítést és támogatják a verziókezelést. A minőségi véglegesítési üzenetek prioritása javítja a fejlesztési folyamatokat és biztosítja a kódbázis karbantarthatóságát.