1. Ohjelmointi 2: Rakenteet »
  2. Vektori ja siihen liittyvä projekti »
  3. Tyyliseikkoja »
  4. (K) Hyvä/huono commit-viesti

(K) Hyvä/huono commit-viesti

Tavoite: Osaan kirjoittaa hyvän commit-viestin. (Tämä on oleellista erityisesti tämän kierroksen projektissa, koska myös versionhallinnan käyttöä arvioidaan.)

Commit-viesti on sitä parempi, mitä pidempi se on.
Commit-viesti on sitä parempi, mitä lyhyempi se on.
Commit-viestit kannattaa numeroida (commit1, commit 2 jne), jotta tiedetään, missä järjestyksessä ne on tehty.
Hyvä commit-viesti kuvaa mielialaa, joka sinulla oli sen tehdessäsi.
Hyvä commit-viesti auttaa muistamaan, mitä tehty muutos pitää sisällään.
Commit-viestissä on hyvä kertoa, mihin tiedostoon/tiedostoihin muutos kohdistui.
Commit-viestissä on hyvä käyttää minä-muotoa.
Commit-viestissä on hyvä kertoa, mitä on muutettu edelliseen versioon verrattuna ja miksi.
Commit-viestissä on hyvä kertoa, miten muutos on tehty.
Commit-viestissä ei pitäisi luetella pitkää listaa muutoksista, vaan muutokset pitäisi jakaa useampiin committeihin.