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.

Structure

<type>: <description>

[optional body]

[optional footer(s)]

Types

  • feat Commits, that add or remove a new feature
  • fix Commits, that fix a API or UI bug of a preceded feat commit
  • refactor Commits, that rewrite/restructure your code, however do not change any API or UI behaviour
    • perf Commits are special refactor commits, that improve performance
  • style Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc)
  • test Commits, that add missing tests or correcting existing tests
  • docs Commits, that affect documentation only
  • build Commits, that affect build components like build tool, ci pipeline, dependencies, project version, ...
  • ops Commits, that affect operational components like infrastructure, deployment, backup, recovery,

Breaking Changes

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.

⚠️ **GitHub.com Fallback** ⚠️