Commit message format

Owned by Oliver Graf
Last updated: Sept 22, 2024
1 min read

The project follows loosely the Conventional Commits Specification. This looks like this:

<type>[optional scope]: <description> [optional body] [optional footer]

For types we commonly use the following types:

  • fix - some bug or error got fixed

  • feat - some new feature or enhancement was added

  • docs - commit only contains documentation changes

  • style - style changes like white-space and other formatting

  • refactor - A code change that neither fixes a bug nor adds a feature

  • test - adding missing tests or correcting existing tests

  • build - Changes that affect the build system or external dependencies

  • optional ! after the type signifies a breaking change. We try not to do those!

The optional scope (in brackets) lists the file or part of the source effected. The description must be a very short abstract of the change and must include the issue number prefixed with a #.

The body may contain a more verbose description of the change.

Possible footers:

  • BREAKING CHANGE: - marks a commit containing some breaking change, we try not to do those!

Examples

fix(viciv.vhdl): some pixel did not show #123 The render pipeline did skip some pixels. Fixed it.
feat(megaflash): add subslot core support #912