Hvordan du kan laver gode commit messages og gør dine kollegaer glade

Jeg ved ikke om du rent faktisk kan gøre din kollegaer glade, eller om de altid er lidt sure ;-) men jeg bliver glad når jeg ser en ordenligt git commit message.

Men hvad er så en god commit message?

Den er delt fornuftigt op

Hvis du opdatere et plugin i wordpress som du checker ind, så lad det være et commit i selv sig. Det vil sige du skal ikke i samme commit opdatere et plugin som er andres kode og samtidigt commit dit kode. Det gør det meget svært for andre at se hvad det er rent faktisk du har lavet, og det er jo synd!

Skriv noget fornuftigt

Lad vær med at skrive: "masse opdateringer" eller "going home commit". Det giver ingen mening for den som gerne vil hurtigt op to speed på hvad der er sket på projektet. Hvis din projektleder gerne på 1 minut vil se hvad der er sket den sidste uge, så er det lige pludselig meget svært og tidskrævende. Er det fordi du har lavet så meget at det ikke kan stå i et commit, så split det op. Commit flere gange hvis det skal være.

Huske at tagge commit

Er projektet afsluttet, så tag dit commit med version 1.0, så kan man forholde sig til hvor langt projektet er nået.

Brug Githubs quick-close keywords

På github kan du nemt lukke en issue ved i dit commit skrive "Fixed #56". Det er super fedt, og gør det nemt at følge issues og hvilke commit som lukkede de forskellige.

Hvis du følger disse råd er jeg sikker på at dine kollegaer som arbejder sammen med dig er glade for dig :-) heh