Aan de slag
Leer onze commitconventie
2 min read
•278 wordsWe vinden het belangrijk om een schone projectgeschiedenis te hebben. Onze commit-conventie is geïnspireerd door Conventional Commits maar aangepast met gitmoji om het visueler en leuker te maken.
Structuur
De commit-bericht moet als volgt gestructureerd zijn en in kleine letters:
<gitmoji> <type> <beschrijving> [(#<issue nummer>)]
[optionele body]
[optionele footer(s)]
Voorbeeld
📝 update documentatie bijdragers
- Voeg @jerembdn toe als bijdrager
- Voeg @younesbessa toe als bijdrager
Co-authored-by: Younes Bessa <[email protected]>
De meeste tijd is een eenvoudige one-liner genoeg:
📝 update documentatie bijdragers
Types
We gebruiken de volgende commit types:
| Type | Beschrijving |
|---|---|
add | Voeg een nieuwe functie toe |
fix | Los een bug op |
improve | Verbeter iets |
update | Update iets |
remove | Verwijder iets |
refactor | Refactor iets |
rename | Hernoem iets |
move | Verplaats een bestand of map |
upgrade | Upgrade afhankelijkheden |
downgrade | Downgrade afhankelijkheden |
Beschrijving
Schrijf beschrijvingen in imperatieve vorm en kleine letters:
# Goed
📝 update documentatie bijdragers
# Slecht
📝 updated documentatie bijdragers
# Slecht
📝 Update documentatie bijdragers
Issue Nummer
Koppel commits aan issues door het issue nummer toe te voegen:
📝 update documentatie bijdragers (#123)
Body
Gebruik de body voor context en motivatie:
📝 update documentatie bijdragers
- Voeg @jerembdn toe als bijdrager
- Voeg @younesbessa toe als bijdrager
Co-authored-by: Younes Bessa <[email protected]>
Eén Commit, Één Doel
Elke commit moet een enkele logische wijziging vertegenwoordigen. Meng geen niet-gerelateerde wijzigingen.
Last updated on 01/14/2026