Conventional Commits - IP-2025/waves-of-the-fallen GitHub Wiki
The Conventional Commits specification is a set of rules for writing clear and consistent commit messages, making it easier to automate processes and align with Semantic Versioning by clearly indicating features, fixes, and breaking changes.
<type>: <description>
[optional body]
[optional footer(s)]
-
featCommits, that add or remove a new feature -
fixCommits, that fix a API or UI bug of a precededfeatcommit -
refactorCommits, that rewrite/restructure your code, however do not change any API or UI behaviour-
perfCommits are specialrefactorcommits, that improve performance
-
-
styleCommits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc) -
testCommits, that add missing tests or correcting existing tests -
docsCommits, that affect documentation only -
buildCommits, that affect build components like build tool, ci pipeline, dependencies, project version, ... -
opsCommits, that affect operational components like infrastructure, deployment, backup, recovery,
To simplify debugging, significant and important changes should be marked with !
Additionally, they should be described in the footer using the format:
BREAKING CHANGE: followed by a detailed explanation.