Commit-viesteistä¶

Commit-viestin tarkoitus on kertoa, mikä muutos tehtiin. Tämä on tärkeää, jotta voisit myöhemmin helpommin löytää oikean version, johon palata, jos jotakin menee vikaan. Joskus viestejä voi joutua selaamaan pitkänkin ajan jälkeen niiden kirjoittamisesta.

Commit-viestin on hyvä olla sen verran pitkä, että siitä selviää tehty muutos, mutta samalla viestin pitäisi olla mahdollisimman lyhyt ja ytimekäs. Yhdessä commitissa pitäisi tehdä vain yksi muutos, jolloin viestikin on helpompi pitää lyhyenä. Jos on tarvetta pidemmälle selitykselle, commit-viesti voidaan jakaa otsikkoon ja runkoon. Tällöin rungossa voidaan selittää myös, miksi muutos tehtiin.

Viestissä ei tarvitse kertoa, mihin tiedostoon muutos kohdistui, koska viestit näkyvät Gitissä vain niiden tiedostojen kohdalla, joita muutettiin. Sen sijaan viestissä on hyvä kertoa esimerkiksi, mihin funktioon muutos kohdistui.

Usein englanninkielisissä ohjeissa neuvotaan käyttämään komentomuotoa, ja tätä samaa tapaa voi käyttää myös suomenkielisissä viesteissä. Tällöin sopivia aloitussanoja (aloitusverbejä) ovat esimerkiksi:

• Lisää

• Poista

• Päivitä

• Korjaa

• Refaktoroi

Esimerkkejä kokonaisista viesteistä:

• Lisää funktio X

• Poista vanhentuneita metodeita

• Päivätä aloitusohjeiden dokumenttia

• Korjaa funktiossa X ollut virhe,

missä X korvataan ohjelmassa oikeasti esiintyvällä nimellä.

Yllä olevista esimerkeistä huomataan, että viesti aloitetaan isolla alkukirjaimella, ja loppuun ei laiteta pistettä.