Hoppa till innehåll

Commit messages

Riktlinjer för commit messages:

  • Skriv commit-meddelandet på svenska

  • Om möjligt, ta alltid med jira-ärendets nummer (skrivet i versaler) inom hakparenteser. Ärendenumret skrivs alltid först i meddelandet.
    Exempel: [JIRA-123] <commit-meddelande>, [ABCD-313] Lägg till webbapp XYZ, [EF-12] Uppdatera @soleil/sv-js-build till v1.2.0
    I de fall då det inte finns något lämpligt jira-ärende kopplat till commiten är det tillåtet att utelämna ärendetnumdret.
    Exempel: Lägg till node_modules/ i .gitignore, Uppdatera README, Lägg till "sass" i tasks i project_config

  • Använd imperativ när du formulerar meddelandet. Med andra ord: skriv meddelandet som en order. Du säger åt commiten vad den ska göra (inte vad du har gjort).
    Exempel - do: Lägg till X, Ta bort Y, Uppdatera Z
    Exempel - don’t: La till X, Tog bort Y, Uppdaterade Z

  • Skriv ett kort och koncist meddelande som talar om vad commiten gör. Vad har förändrats. Ju tydligare desto bättre - det blir enklare att hitta en specifik ändring i historiken då.
    Exempel - do: Byt bakgrundsfärg på nyheter i artikellistningen, Ta bort margin-right på sista elementet i listan
    Exempel - don’t: Styla artikellistningen, Fixa mellanrummet

  • Dela upp koden så att en commit bara gör en sak.
    Exempel: Lägg till komponent List.svelte, Sätt rubrikens typsnitt till Roboto, Fixa bugg som bara listade de tre första nyheterna

  • Undvik att använda multi-line i meddelandet om möjligt

  • Skriv inte fler än 50 tecken i ett commit-meddelande

  • Börja meddelandet med stor bokstav

  • Avsluta meddelandet utan punkt

Se skärmdump nedan för exempel på hur en git historik kan se ut om ovannämnda riktlinjer appliceras.

Skärmdump från GitHub, bilden visar hur en git historik kan se ut om ovannämnda riktlinjer appliceras