Skip to content

Commit message format

Commit messages follow this format:

{commit type}: #{issue ID} One line summary of the change

By: user1
By: user2

The By: lines credit everyone who contributed to the commit, using drupal.org usernames.

Commit types

Commit type Title Description
fix Bug fix A bug fix
feat Feature A new feature
ci Continuous Integration Changes to our CI configuration files and scripts (e.g. .gitlab-ci.yml changes)
docs Documentation Changes only to the documentation
perf Performance improvements A code change that improves performance
refactor Code Refactoring A code change that neither fixes a bug nor adds a feature
test Test-only changes Adding missing tests or correcting existing tests
task Task A code change that does not easily fit into any other category. For example, bumping the versions of dependencies in composer.lock, or a blend of refactor and docs, etc.
revert Revert Reverts a previous commit

This format is specific to LocalGov Drupal, so it differs a little from the Drupal core commit convention. For background on the core convention, see The format of the git commit message.