Kom igång
Lär dig vår commit-konvention
2 min read
•267 wordsVi gillar att ha en ren projektlogg. Vår commit-konvention är inspirerad av Conventional Commits men anpassad med gitmoji för att göra den mer visuell och rolig.
Struktur
Commit-meddelandet bör struktureras som följande och i gemener:
<gitmoji> <typ> <beskrivning> [(#<ärendenummer>)]
[valfritt brödtext]
[valfria fotnot(er)]
Exempel
📝 uppdatera dokumentation bidragsgivare
- Lägg till @jerembdn som bidragsgivare
- Lägg till @younesbessa som bidragsgivare
Co-authored-by: Younes Bessa <[email protected]>
Det mesta av tiden är en enkel rad tillräcklig:
📝 uppdatera dokumentation bidragsgivare
Typer
Vi använder följande commit-typer:
| Typ | Beskrivning |
|---|---|
add | Lägg till en ny funktion |
fix | Åtgärda en bugg |
improve | Förbättra något |
update | Uppdatera något |
remove | Ta bort något |
refactor | Refaktorisera något |
rename | Byt namn på något |
move | Flytta en fil eller mapp |
upgrade | Uppgradera beroenden |
downgrade | Nedgradera beroenden |
Beskrivning
Skriv beskrivningar i imperativ form och gemener:
# Bra
📝 uppdatera dokumentation bidragsgivare
# Dåligt
📝 uppdaterade dokumentation bidragsgivare
# Dåligt
📝 Uppdatera dokumentation bidragsgivare
Ärendenummer
Länka commits till ärenden genom att lägga till ärendenumret:
📝 uppdatera dokumentation bidragsgivare (#123)
Brödtext
Använd brödtexten för sammanhang och motivation:
📝 uppdatera dokumentation bidragsgivare
- Lägg till @jerembdn som bidragsgivare
- Lägg till @younesbessa som bidragsgivare
Co-authored-by: Younes Bessa <[email protected]>
En Commit, En Syfte
Varje commit bör representera en enda logisk förändring. Blanda inte orelaterade förändringar.
Last updated on 01/14/2026