Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

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

  • 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 including 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
style: fixed whitespace and indent

  • No labels