Skip to main content

Conventional Commits

Configure

Commit format

text

<type>(<scope>): <description>

[optional body]

[optional footer(s)]

Use the same shape for PR titles because the project relies on squash merge and changelog automation.

Reference table

Common commit types

Common commit types.
TypeUse it forRelease effect
featnew user-visible or contributor-visible functionalityminor
docsdocumentation-only changespatch
refactorcode changes that do not add a feature or fix a bugpatch
testtest additions or correctionspatch
build, ci, chorebuild-system, workflow, or maintenance changespatch
revertreversal of a previous changepatch

Reference table

Common scopes in this repository

Common scopes in this repository.
ScopeArea it maps to
api, controller, infra, config, security, rbaccore controller and platform areas
backup, restore, upgrade, bluegreenmanager and lifecycle features
charts, manifests, deps, build, ci, docs, aitooling, artifacts, workflows, and docs
test(unit), test(integration), test(e2e)test-only changes with explicit layer scoping
Breaking changes

Mark a breaking change with ! after the type or scope, or use a BREAKING CHANGE: footer when the description needs more room.

CI enforcement

The repository validates Conventional Commit format in CI for:

  • PR titles, which are required for the squash-merge workflow
  • commit-subject checks, which remain informational rather than blocking

Related contributor pages

Next release documentation

You are reading the unreleased main docs. Use the version menu for the newest published release, or check the release notes for what is already out.

Was this page helpful?

Use Needs work to open a structured GitHub issue for this page. The Yes button only acknowledges the signal locally.