Best practices voor commitberichten
Pas conventies toe voor duidelijke, beknopte en informatieve commitberichten die de leesbaarheid van de projectgeschiedenis verbeteren.
Best practices voor commitberichten is een gratis DevOps-bootcamp-les op CoddyKit. Dit is les 3 van 4. Je kunt 3 lessen uit dit leerpad gratis volledig lezen — daarna ontgrendelt CoddyKit PRO alle lessen, plus praktische oefeningen met een ingebouwde code-editor en een AI-tutor die 24/7 beschikbaar is. Deze les maakt deel uit van het leertraject DevOps-bootcamp. Je voortgang wordt gesynchroniseerd op het web en in de CoddyKit-app. De cursus DevOps-bootcamp bevat in totaal 4 lessen.
Waarom goede commits belangrijk zijn
Stel je voor dat je terugkijkt op de geschiedenis van je project. Zonder duidelijke commitberichten is het alsof je een dagboek met lege pagina's leest!
Goede commitberichten zijn essentieel om te begrijpen waarom wijzigingen zijn aangebracht, wat er is gewijzigd en welke invloed die wijzigingen op het project hebben. Dit helpt jou en je team bij het opsporen van fouten, het beoordelen van code en het inwerken van nieuwe teamleden.
Opbouw van een commitbericht
Een standaard Git-commitbericht bestaat uit twee hoofdonderdelen:
- Onderwerpregel: één beknopte regel die de wijziging samenvat.
- Hoofdtekst (optioneel): een uitgebreidere uitleg, gescheiden van het onderwerp door een lege regel.
Zie het als een e-mail: een onderwerpregel om snel te kunnen scannen en een hoofdtekst voor de details.
De onderwerpregel schrijven
De onderwerpregel is het belangrijkste onderdeel. Dit zijn de regels:
- Beknopt: houd de regel korter dan 50-72 tekens.
- Gebiedende wijs: begin met een werkwoord in de tegenwoordige tijd, bijvoorbeeld "Add feature" en niet "Added feature" of "Adding feature".
- Eerste letter als hoofdletter: dit is gebruikelijk voor de leesbaarheid.
- Geen punt: eindig de onderwerpregel niet met een punt.
Voorbeelden van onderwerpregels
Bekijk enkele goede en slechte onderwerpregels:
- Goed:
Fix: broken login button - Goed:
Feat: implement user profile page - Slecht:
Fixed a bug in the login system that was causing issues.(te lang, verleden tijd) - Slecht:
updates(te vaag)
Streef naar duidelijkheid en beknoptheid!
De hoofdtekst van een commit: leg het 'waarom' uit
In de hoofdtekst van een commit leg je de motivatie voor de wijziging, de context en eventuele details uit die niet direct uit de code zelf blijken.
Gebruik de hoofdtekst wanneer je wijziging meer uitleg nodig heeft dan de onderwerpregel kan bieden. Breek regels af rond 72 tekens voor een betere leesbaarheid in Git-hulpprogramma's.
Richtlijnen voor de inhoud van de hoofdtekst
Let bij het schrijven van de hoofdtekst op het volgende:
- Leg uit waarom de wijziging is aangebracht, niet alleen wat er is gewijzigd.
- Beschrijf eventuele afwegingen of ontwerpbeslissingen.
- Noem mogelijke bijwerkingen of onderdelen waarop je moet letten.
- Laat een lege regel staan tussen het onderwerp en de hoofdtekst.
Zo bied je waardevolle context aan toekomstige lezers.
Voorbeeld van een volledig commitbericht
Zo kan een volledig, goed gestructureerd commitbericht eruitzien:
feat: add user authentication via email/password
This commit introduces a new user authentication system.
Users can now register with an email and password, and log in.
Key changes include:
- New /register and /login API endpoints.
- Integration with bcrypt for password hashing.
- JWT token generation for session management.
Closes #42Typevoorvoegsels gebruiken (Conventional Commits)
Veel teams gebruiken een conventie waarbij de onderwerpregel begint met een typevoorvoegsel. Zo kun je wijzigingen snel categoriseren.
Veelgebruikte voorvoegsels zijn:
feat:(nieuwe functie)fix:(bugfix)docs:(wijziging in documentatie)style:(codestijl, geen functionele wijziging)refactor:(code herstructureren)test:(tests toevoegen)chore:(onderhoud, wijzigingen in het bouwproces)
Verwijzen naar issues en PR's
Het is een goede gewoonte om je commits te koppelen aan gerelateerde issues of pull requests in het projectbeheersysteem van je project, zoals GitHub Issues of Jira.
Dat doe je door formuleringen als Closes #123, Fixes #45 of Refs #67 in je commitbericht op te nemen, meestal in de hoofdtekst. Zo worden je codewijzigingen automatisch gekoppeld aan de taak die wordt bijgehouden.
Controle van commitberichten
Welke van de volgende opties zijn volgens de best practices kenmerken van een goed geschreven Git-commitbericht?
Samenvatting: beheers je commits
Je hebt geleerd dat goed geschreven commitberichten essentieel zijn voor duidelijkheid binnen een project en voor samenwerking. Door deze best practices te volgen, maak je van de geschiedenis van je project een waardevolle bron!
- Houd onderwerpregels beknopt en gebruik de gebiedende wijs.
- Gebruik de hoofdtekst om uit te leggen 'waarom' een wijziging is aangebracht.
- Overweeg typevoorvoegsels voor categorisering.
- Verwijs naar issues of pull requests voor context.
Veel succes met committen!
Leer DevOps-bootcamp met een AI-tutor — gratis
Schrijf echte code en voer die uit in je browser, krijg direct hulp van een AI-tutor die 24/7 beschikbaar is en ga verder waar je gebleven bent op het web of in de app.
- Cursussen
- 142
- Lessen
- 568
Veelgestelde vragen
Is de les “Best practices voor commitberichten” gratis?
Ja — je kunt hier op het web alle 3 lessen van het leerpad DevOps-bootcamp, waaronder “Best practices voor commitberichten”, gratis volledig lezen. Daarna ontgrendelt CoddyKit PRO alle lessen, plus interactieve oefeningen met een ingebouwde code-editor en een AI-tutor die 24/7 beschikbaar is. De cursus DevOps-bootcamp bevat in totaal 4 lessen.
Wat leer ik in “Best practices voor commitberichten”?
Pas conventies toe voor duidelijke, beknopte en informatieve commitberichten die de leesbaarheid van de projectgeschiedenis verbeteren. Je oefent met DevOps-bootcamp door code rechtstreeks in de browser uit te voeren. Een AI-begeleider die 24/7 beschikbaar is beantwoordt je vragen terwijl je de les doorwerkt.
Heb ik ervaring nodig om met DevOps-bootcamp te beginnen?
Ervaring vooraf is niet nodig. DevOps-bootcamp op CoddyKit is opgebouwd voor beginners tot gevorderden, zodat je hier of bij het begin kunt starten en in je eigen tempo kunt leren. Dit is les 3 van 4.
Hoe lang duurt de les “Best practices voor commitberichten”?
De meeste lessen van CoddyKit duren ongeveer 5–10 minuten. Elke les is kort en interactief, zodat je gestaag vooruitgaat en op het web en in de app precies verdergaat waar je was gebleven.
Kan ik code schrijven en uitvoeren in deze les over DevOps-bootcamp?
Ja. Elke les over DevOps-bootcamp bevat een ingebouwde code-editor, zodat je rechtstreeks in je browser echte code kunt schrijven en uitvoeren en direct feedback van AI krijgt — lokale installatie is niet nodig.
Alle lessen in deze cursus
- Uw Git-workflow beveiligen
- Gevoelige gegevens beheren (Git LFS)
- Best practices voor commitberichten
- Commits en tags ondertekenen met GPG