Skip to content

Git best practices

Git commit message

Commit message

Een commit message is een korte beschrijving van de veranderingen die je hebt gemaakt. Een commit message is een korte zin die begint met een werkwoord in de verleden tijd. Bijvoorbeeld:

  • fix bug in login form
  • add new feature to login form
  • remove unused code from login form

Tip

Refereer in je commit aan een Gitlab-issue door de id bijv. #17 te vermelden in de commit message.

Commit message template

Om ervoor te zorgen dat je commit messages consistent zijn, kun je een commit message template gebruiken. Een commit message template is een bestand met daarin een aantal regels die je kunt gebruiken om je commit message te schrijven. Je kunt een commit message template gebruiken door de volgende commando’s uit te voeren:

$ git config --global commit.template ~/.gitmessage

$ echo "Subject line" > ~/.gitmessage
$ echo >> ~/.gitmessage
$ echo "Multi-line description of commit," >> ~/.gitmessage
$ echo "feel free to be detailed." >> ~/.gitmessage
$ echo >> ~/.gitmessage
$ echo "Fixes #1" >> ~/.gitmessage