We’re using the following Git workflow:
Please read the next chapters to get more details on our workflow.
Pushing to the
master branch is not allowed. Instead of it do the following:
Create feature branches for your changes.
Open a Gitlab Merge Request to merge your branch into
Make sure your feature branch is rebased to
masterbefore opening the merge request.
master branch so that pushes are not allowed. Also make sure merge requests are fast-forwarded.
The branch name should briefly describe the contained changes and/or what it’s trying to achieve. However, there are some restricted branch names, i.e.:
masteris our main branch (bleeding edge, latest greatest, and so on)
release-*is a freezed release branch, which is used for tagging & merged back into
hotfix-*is a hotfix branch, which fixes something on the current productive version
In case you’ve a Gitlab issue, you can simply create a new branch by clicking on a button in the issue. This way, the branch is linked to the issue.
master branch is the only eternal branch. All other branches, such as feature, release & hotfix branches are ephemeral.
Make sure you prefix your commit messages with one of the following prefixes:
FEATURE: Add new SPAM feature
FIX: Fix the annoying SPAM bug
REFACTOR: Refactor code of SPAM(code is changed, isn’t styling only)
STYLE: Remove superfluous spaces from SPAM(code is not affected, only styling)
CLEANUP: Remove unused imports from SPAM
DOC: Update the documentation of SPAM
TEST: Add new CI test for SPAM
BUILD: Exclude SPAM from package build
PIPELINE: Update CI/CD pipeline to deploy SPAM
MISC: Add SPAM to .gitignore
REVERT: Reverted the SPAM commit
All allowed prefixes can be found in
Please follow these rules for a good subject:
Limit the summary (aka subject) to 50 characters
Capitalize the sentence
Do not end the sentence with a period, as it’s unnecessary
Use the imperative mood
Using imperative mood can be tricky at first. Just remember these rules:
Write the subject as if it’s a command or instruction
The subject must be able to complete the sentence “This commit will…”
We’re automatically generating the Git Changelog from Git commit messages.
Always use proper commit messages. Commit messages must be meaningful and short at the same time. Things like
Changed some files,
Fix are not proper commit messages and you’ll burn in hell for it!
Also ensure you don’t use identical summaries for multiple commits. You might want to squash them instead.
Please follow these rules for a good description:
Wrap the description (aka body) at 72 characters
Use it to describe the what and why
Do not describe the how, as this describes the changeset itself
Clearly mention any related issue numbers with the GitLab syntax (i.e.