git - claudiobak/Backend GitHub Wiki

Version control

Voor de version control gebruiken we Github. Normaliter zou je verschillende branches aanmaken om zo een goed overzicht te houden in het werk. Vervolgens kunnen deze branches weer gemerged worden met de main branch. Echter omdat ik deze opdracht individueel maak, leek het mij handiger en overzichtelijker om in plaats hiervan maar met een branch te werken.

Ik heb regelmatig mijn code naar Github gepushed, dit vond ik persoonlijk erg fijn omdat als ik aanpassingen ging maken in de code ik altijd nog een backup had van mijn code zelf.

Hoe commit je naar je Github repo?

Om je code naar github te pushen, voer je drie stappen uit. Als eerst type je in de terminal:

git add .

Vervolgens type je:

git commit -m "message"

En als laatste type je:

git push

image

Git commit messages onderzoek

Er zijn veel verschillende manieren om je git messages in te delen. In een artikel die ik vond op freecodecamp.org (freecodecamp.org, 2022) beschreven ze 5 stappen om betere commit messages te schrijven:

  1. Capitalization and punctuation: Schrijf het eerste woord van je commit message met een hoofdletter en gebruik geen punten.
  2. Mood: Type je commit messages in de imperative mood/gebiende wijs, hiermee geeft het de toon dat je een bevel geeft.
  3. Type of commit: Specificeer het type commit wat je doet. Bijv. Bugfix Update, Refactor etc.
  4. Length: De eerste regel moet idealiter niet langer zijn dan 50 tekens en de body mag niet langer zijn dan 72 characters.
  5. Content: Wees direct en elimineer filler woorden en zinnen.

Mijn aanpak

De manier waarop ik mijn commit messages schrijf is als volgt:

  • added Wanneer ik iets nieuws heb toegevoegd.
  • changed Wanneer ik iets heb aangepast.
  • fixed Als ik iets wat ik al had werkend heb gemaakt.
  • removed Als ik iets verwijderd heb.
  • updated Deze ligt eigenlijk in het verlengde van changed en fixed, en gebruik ik als ik de code op een betere/semantischere manier heb herschreven.

Ook schrijf ik mijn commit messages allemaal in de verleden tijd, dit vind ik prettiger voor als ik het terug lees.

github logo illustration