Commit zpráva je pro budoucí čtenáře historie vašeho projektu to nejdůležitější svědectví o tom, co jste změnili a proč. Když ji napíšete ledabyle, stává se z verzování kódu spíše překážka než pomocník. Základním pravidlem je oddělit krátký souhrn (do padesáti znaků) od těla zprávy prázdným řádkem. V souhrnu použijte rozkazovací způsob a popište akci, ne výsledek: místo „opraven bug“ napište „oprav výpočet daně z přidané hodnoty“. Tělo zprávy pak věnujte vysvětlení kontextu: proč jste zvolili toto řešení, jaké alternativy jste zavrhli a jaké vedlejší efekty změna přináší. Vyhněte se obecným frázím jako „úpravy“ či „refaktoring“ – místo nich konkrétně uveďte, které funkce nebo soubory jste měnili a jaký problém to řeší. Čtenář, který za půl roku prochází log, vám poděkuje za každou větu, která mu ušetří otevírání diffu.
více zde to vypadá tak, že si před odesláním commitu vždy projdete změny a zodpovíte si tři otázky: Co přesně dělá tento kód nově? Proč to dělá zrovna takhle a ne jinak? Jaké jsou případné limity či nezbytné návaznosti? Odpovědi pak shrňte do dvou až čtyř vět v těle zprávy. Pokud je změna rozsáhlá, rozdělte ji na logické celky a commitněte je odděleně – každý commit by měl být samostatný, srozumitelný krok. Nepoužívejte emotikony ani nadměrnou interpunkci, ale také se nebojte být osobní, když to pomůže. Například věta „Filtr nefungoval kvůli chybějící inicializaci pole, což způsobovalo pád na prázdném vstupu“ je srozumitelnější než suché „fix bug“. Dbejte také na to, aby souhrn začínal slovesem („přidej“, „oprav“, „odstraň“), což usnadňuje skenování seznamu commitů.
Nakonec si uvědomte, že psaní commit zpráv je disciplína, která se vyplácí hlavně při práci v týmu nebo při návratu k vlastnímu staršímu kódu. Kvalitní historie vám umožní rychle najít, kdy a proč se konkrétní chování změnilo, a díky tomu se vyhnout zbytečnému pátrání v dřívějších verzích. Začněte u sebe a vytvořte si osobní šablonu, kterou budete dodržovat: nejprve souhrn, pak prázdný řádek, pak kontext. Po nějaké době vám to půjde automaticky a stanete se tím, ke komu ostatní chodí pro radu, jak ve verzování kódu hledat souvislosti. Pamatujte, že commit zpráva není formalita, ale nástroj pro efektivní spolupráci – čím jasnější bude, tím méně času všichni stráví dohledáváním informací. Nakonec si přečtěte své vlastní zprávy z doby před měsícem; pokud jim rozumíte bez otevírání kódu, píšete je správně.