Skip to content

Alternative "GL-" prefix for crosslinking issues

Problem to solve

The # is currently used in order to crosslink issues in commit messages, issues, wikis etc.

However, the # prefix cannot be used when enforcing every commit message to reference the issue upfront, examples:

#1234: Improve documentation
#2345: Add new locale fr-CA

This won't work because # is the default comment character for Git and therefore, Git messages cannot begin with a hash. Too bad since enforcing the reference upfront has quite a number of advantages. Enough advantages for GitHub to introduce the alternative prefix GH- quite some time ago.

Intended users

Projects which enforce issue references upfront in every commit message.

(Otherwise, the only "fix" for projects with upfront issue references is to tell every developer to change the default comment character for Git. Bad idea! In 9 out of 10 cases, this is not feasible e.g. because this breaks Git clients which are often unaware of this setting.)

Proposal

Similar to the alternative prefix GH- on GitHub, implement the alternative prefix GL- on GitLab:

GL-1234: Improve documentation
GL-2345: Add new locale fr-CA

Documentation

Availability & Testing

Links / references

Edited by 🤖 GitLab Bot 🤖