Best Practices

1. Bevezetés¶

A szabványok ismerete mellett a professzionális szoftvermérnöki munka megkövetel bizonyos alapelveket, amelyek biztosítják a tiszta és követhető történetet.

1.1. Atomi commitok és a staging area kihasználása¶

A legfontosabb szabály az atomiság: egy commit egyetlen logikai feladatot lásson el. Ha két különböző hiba javításán dolgozunk egyszerre, ne egy közös üzenettel küldjük be őket. A Git "Staging Area" (vagy index) funkciója pontosan ezt teszi lehetővé: a git add -p (patch mode) használatával fájlokon belüli módosítás-darabkákat (hunks) válogathatunk össze különböző commitokba. Ez megkönnyíti a későbbi hibakeresést (pl. git bisect használatával) és a hibás módosítások biztonságos visszavonását.

1.2. A "MIÉRT" dokumentálása a "HOGYAN" helyett¶

Gyakori hiba, hogy a fejlesztők a commit törzsében azt írják le, mit változtattak a kódban. Ez felesleges, hiszen a kódváltozás (diff) pontosan megmutatja a módosításokat. A törzsnek a változtatás motivációját kell tartalmaznia: mi volt a probléma, milyen alternatívákat mérlegeltünk, és miért választottuk az adott megoldást. Egy jól megírt törzs évekkel később is érthetővé teszi a döntési folyamatot egy olyan kolléga számára, aki nem volt ott a kód születésekor.

1.3. Magyar kontextus és szaknyelvi dilemmák¶

Magyar nyelvű fejlesztőcsapatokban gyakori kérdés, hogy milyen nyelven szülessenek a commitok. Az iparági standard egyértelműen az angol, még akkor is, ha a csapat minden tagja magyar. Ennek oka, hogy a szoftverek és a könyvtárak gyakran globális közönségnek készülnek, az AI eszközök és linterek angol nyelven működnek a leghatékonyabban, és a szakmai szakkifejezések (pl. refactor, middleware, hook) magyarra fordítása gyakran erőltetett vagy félreérthető. A magyar nyelvű commitok gyakran a projekt "ideiglenességét" vagy komolytalanságát sugallják a nemzetközi partnerek felé.