Commit-viestit

Commit-viestin tarkoitus on kertoa, mitä muutettiin. Selkeiden viestien avulla löydät myöhemmin helpommin oikean version, johon palata, jos jokin menee vikaan. Viestejä saatetaan selata vielä pitkänkin ajan kuluttua niiden kirjoittamisesta.

Pidä viesti ytimekkäänä

Kirjoita viestiin riittävästi tietoa, jotta tehty muutos käy ilmi, mutta pyri samalla pitämään se lyhyenä. Tee yhteen commitiin vain yksi looginen muutos. Näin sekä muutos että sitä kuvaava viesti pysyvät selkeinä.

Jos muutos vaatii pidemmän selityksen, jaa viesti otsikkoon ja runkoon. Otsikko kertoo lyhyesti, mitä tehtiin. Rungossa voit selittää muutoksen taustaa ja sitä, miksi se tehtiin.

Kerro muutoksesta, älä tiedostonimestä

Commit-viestissä ei yleensä tarvitse luetella muokattuja tiedostoja: Git näyttää, mihin tiedostoihin commit vaikutti. Kuvaa sen sijaan muutosta tai sen kohdetta, esimerkiksi funktiota, johon muutos liittyy.

Aloita tekemistä kuvaavalla verbillä

Englanninkielisissä ohjeissa suositellaan usein käskymuotoa. Sama tapa toimii suomeksi. Aloita viesti esimerkiksi tekemistä kuvaavalla verbillä:

Lisää
Poista
Päivitä
Korjaa
Refaktoroi

Esimerkiksi:

Lisää funktio X
Poista vanhentuneita metodeita
Päivitä aloitusohjeiden dokumentti
Korjaa funktiossa X ollut virhe

Esimerkeissä viesti alkaa isolla alkukirjaimella ja loppuu ilman pistettä. Kun nimeät funktion, korvaa X ohjelmassa oikeasti esiintyvällä nimellä.

Muista: hyvä commit-viesti kertoo yhdellä silmäyksellä, mitä yhdessä loogisessa muutoksessa tehtiin.